Class CompositeByteBuffer

Namespace

FellowOakDicom.IO.Buffer

Assembly

fo-dicom.core.dll

Implementation of an IByteBuffer consisting of a collection of IByteBuffer instances.

public class CompositeByteBuffer : IByteBuffer

Inheritance

object

CompositeByteBuffer

Implements

IByteBuffer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LinqExtensions.IsOneOf<T>(T, params T[])

ByteBufferExtensions.Enumerate<T>(IByteBuffer)

Constructors

CompositeByteBuffer(params IByteBuffer[])

Initializes an instance of the CompositeByteBuffer class.

public CompositeByteBuffer(params IByteBuffer[] buffers)

Parameters

buffers IByteBuffer[]

Array of buffers to initially constitute the CompositeByteBuffer instance.

CompositeByteBuffer(IMemoryProvider, params IByteBuffer[])

Initializes an instance of the CompositeByteBuffer class.

public CompositeByteBuffer(IMemoryProvider memoryProvider, params IByteBuffer[] buffers)

Parameters

memoryProvider IMemoryProvider

The memory provider that will be used to allocate buffers

buffers IByteBuffer[]

Array of buffers to initially constitute the CompositeByteBuffer instance.

CompositeByteBuffer(IMemoryProvider, IEnumerable<IByteBuffer>)

Initializes an instance of the CompositeByteBuffer class.

public CompositeByteBuffer(IMemoryProvider memoryProvider, IEnumerable<IByteBuffer> buffers)

Parameters

memoryProvider IMemoryProvider

The memory provider that will be used to allocate buffers

buffers IEnumerable<IByteBuffer>

Collection of buffers to initially constitute the CompositeByteBuffer instance.

CompositeByteBuffer(IEnumerable<IByteBuffer>)

Initializes an instance of the CompositeByteBuffer class.

public CompositeByteBuffer(IEnumerable<IByteBuffer> buffers)

Parameters

buffers IEnumerable<IByteBuffer>

Collection of buffers to initially constitute the CompositeByteBuffer instance.

Properties

Buffers

Gets the collection of IByteBuffer constituting the CompositeByteBuffer.

public IList<IByteBuffer> Buffers { get; }

Property Value

IList<IByteBuffer>

Data

Gets the data.

public byte[] Data { get; }

Property Value

byte[]

IsMemory

Gets whether data is buffered in memory or not.

public bool IsMemory { get; }

Property Value

bool

Size

Gets the size of the buffered data.

public long Size { get; }

Property Value

long

Methods

CopyToStream(Stream)

Copies the contents of this buffer to the provided stream

public void CopyToStream(Stream stream)

Parameters

stream Stream

A stream that will receive the contents of this buffer

CopyToStreamAsync(Stream, CancellationToken)

Copies the contents of this buffer to the provided stream

public Task CopyToStreamAsync(Stream stream, CancellationToken cancellationToken)

Parameters

stream Stream

A stream that will receive the contents of this buffer

cancellationToken CancellationToken

A cancellation token that halts the execution of the copy operation

Returns

Task

GetByteRange(long, int, byte[])

Gets a subset of the data and fills it in the provided output buffer

public void GetByteRange(long offset, int count, byte[] output)

Parameters

offset long

Offset from beginning of data array.

count int

Number of bytes to return.

output byte[]

The array where the data will be written to