Redigera

Dela via


PipeWriter.GetMemory(Int32) Method

Definition

Returns a Memory<T> to write to that is at least the requested size, as specified by the sizeHint parameter.

public abstract Memory<byte> GetMemory (int sizeHint = 0);
abstract member GetMemory : int -> Memory<byte>
Public MustOverride Function GetMemory (Optional sizeHint As Integer = 0) As Memory(Of Byte)

Parameters

sizeHint
Int32

The minimum length of the returned Memory<T>. If 0, a non-empty memory buffer of arbitrary size is returned.

Returns

A memory buffer of at least sizeHint bytes. If sizeHint is 0, returns a non-empty buffer of arbitrary size.

Implements

Exceptions

The requested buffer size is not available.

Remarks

There is no guarantee that successive calls will return the same buffer or the same-sized buffer.

This method never returns Memory<T>.Empty, but it throws an OutOfMemoryException if the requested buffer size is not available.

You must request a new buffer after calling Advance to continue writing more data; you cannot write to a previously acquired buffer.

Applies to