IKVM.CoreLib.Buffers.MemoryBufferWriter< T > Class Template Reference

Implements the IBufferWriter<T> interface around a Memory<T>. More...

Inheritance diagram for IKVM.CoreLib.Buffers.MemoryBufferWriter< T >:

Public Member Functions
	MemoryBufferWriter (Memory< T > memory)
	Initializes a new instance.
void	Clear ()
void	Advance (int count)
Memory< T >	GetMemory (int sizeHint=0)
Span< T >	GetSpan (int sizeHint=0)
override string	ToString ()

Properties
ReadOnlyMemory< T >	WrittenMemory [get]
ReadOnlySpan< T >	WrittenSpan [get]
int	WrittenCount [get]
int	Capacity [get]
int	FreeCapacity [get]

Detailed Description

Implements the IBufferWriter<T> interface around a Memory<T>.

Template Parameters

T

Definition at line 13 of file MemoryBufferWriter.cs.

Constructor & Destructor Documentation

MemoryBufferWriter()

IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.MemoryBufferWriter

(

Memory< T >

memory

)

Initializes a new instance.

Parameters

memory

Definition at line 23 of file MemoryBufferWriter.cs.

        {
            _memory = memory;
        }

Member Function Documentation

Advance()

void IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.Advance

(

int

count

)

Definition at line 72 of file MemoryBufferWriter.cs.

        {
            if (count < 0)
            {
                ThrowArgumentOutOfRangeExceptionForNegativeCount();
            }
 
            if (_index > _memory.Length - count)
            {
                ThrowArgumentExceptionForAdvancedTooFar();
            }
 
            _index += count;
        }

Clear()

void IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.Clear

(

)

Definition at line 65 of file MemoryBufferWriter.cs.

        {
            _memory.Slice(0, _index).Span.Clear();
            _index = 0;
        }

GetMemory()

Memory< T > IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.GetMemory

(

int

sizeHint = 0

)

Definition at line 88 of file MemoryBufferWriter.cs.

        {
            ValidateSizeHint(sizeHint);
 
            return _memory.Slice(_index);
        }

GetSpan()

Span< T > IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.GetSpan

(

int

sizeHint = 0

)

Definition at line 96 of file MemoryBufferWriter.cs.

        {
            ValidateSizeHint(sizeHint);
 
            return _memory.Slice(_index).Span;
        }

ToString()

override string IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.ToString

(

)

Definition at line 126 of file MemoryBufferWriter.cs.

        {
            // See comments in MemoryOwner<T> about this
            if (typeof(T) == typeof(char))
            {
                return _memory.Slice(0, _index).ToString();
            }
 
            // Same representation used in Span<T>
            return $"IKVM.CoreLib.Buffers.MemoryBufferWriter<{typeof(T)}>[{_index}]";
        }

Property Documentation

Capacity

int IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.Capacity

get

Definition at line 51 of file MemoryBufferWriter.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => _memory.Length;
        }

FreeCapacity

int IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.FreeCapacity

get

Definition at line 58 of file MemoryBufferWriter.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => _memory.Length - _index;
        }

WrittenCount

int IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.WrittenCount

get

Definition at line 44 of file MemoryBufferWriter.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => _index;
        }

WrittenMemory

ReadOnlyMemory<T> IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.WrittenMemory

get

Definition at line 30 of file MemoryBufferWriter.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => _memory.Slice(0, _index);
        }

WrittenSpan

ReadOnlySpan<T> IKVM.CoreLib.Buffers.MemoryBufferWriter< T >.WrittenSpan

get

Definition at line 37 of file MemoryBufferWriter.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => _memory.Slice(0, _index).Span;
        }

---

The documentation for this class was generated from the following file:

• src/IKVM.CoreLib/Buffers/MemoryBufferWriter.cs