PooledBuffer Struct

Definition

Namespace:: Orleans.Serialization.Buffers

Assembly:: Orleans.Serialization.dll

Package:: Microsoft.Orleans.Serialization v10.0.0

Package:: Microsoft.Orleans.Serialization v7.2.5

Package:: Microsoft.Orleans.Serialization v8.0.0

Package:: Microsoft.Orleans.Serialization v8.1.0

Package:: Microsoft.Orleans.Serialization v8.2.0

Package:: Microsoft.Orleans.Serialization v9.0.0

Package:: Microsoft.Orleans.Serialization v9.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A IBufferWriter<T> implementation implemented using pooled arrays which is specialized for creating ReadOnlySequence<T> instances.

[Orleans.Immutable]
public struct PooledBuffer : IDisposable, System.Buffers.IBufferWriter<byte>

[<Orleans.Immutable>]
type PooledBuffer = struct
    interface IBufferWriter<byte>
    interface IDisposable

Public Structure PooledBuffer
Implements IBufferWriter(Of Byte), IDisposable

Inheritance: ValueType
PooledBuffer

Attributes: ImmutableAttribute

Implements: IBufferWriter<Byte> IDisposable

Constructors

Name	Description
PooledBuffer()	Initializes a new instance of the PooledBuffer struct.

Properties

Name	Description
Length	Gets the total length which has been written.
MemorySegments	Returns an enumerator which can be used to enumerate the data referenced by this instance.

Methods

Name	Description
Advance(Int32)	Notifies the IBufferWriter<T> that `count` data items were written to the output Span<T> or Memory<T>.
AsReadOnlySequence()	Returns a new ReadOnlySequence<T> which must not be accessed after disposing this instance.
CopyTo(Span<Byte>)	Copies the contents of this writer to a span.
CopyTo<TBufferWriter>(TBufferWriter)	Copies the contents of this writer to another writer.
CopyTo<TBufferWriter>(Writer<TBufferWriter>)	Copies the contents of this writer to another writer.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetEnumerator()	Returns an enumerator which can be used to enumerate the data referenced by this instance.
GetMemory(Int32)	Returns a Memory<T> to write to that is at least the requested size (specified by `sizeHint`).
GetSpan(Int32)	Returns a Span<T> to write to that is at least the requested size (specified by `sizeHint`).
Reset()	Resets this instance, returning all memory.
Slice()	Returns a PooledBuffer.BufferSlice covering this entire buffer.
Slice(Int32, Int32)	Returns a slice of this buffer, beginning at the specified offset and having the specified length.
Slice(Int32)	Returns a slice of this buffer, beginning at the specified offset.
ToArray()	Returns the data which has been written as an array.
Write(ReadOnlySequence<Byte>)	Writes the provided sequence to this buffer.
Write(ReadOnlySpan<Byte>)	Writes the provided value to this buffer.

Extension Methods

Name	Description
GetEnumerator(PooledBuffer)	Returns an enumerator which can be used to enumerate the data referenced by this instance.

Applies to