Class EndianByteBuffer

Namespace

FellowOakDicom.IO.Buffer

Assembly

fo-dicom.core.dll

Representation of an endian-aware byte buffer.

public class EndianByteBuffer : IByteBuffer

Inheritance

object

EndianByteBuffer

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)

Properties

Data

Gets the data.

public byte[] Data { get; }

Property Value

byte[]

Endian

Gets the endianness of the byte buffer.

public Endian Endian { get; }

Property Value

Endian

Internal

Gets the original representation of the byte buffer.

public IByteBuffer Internal { get; }

Property Value

IByteBuffer

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

UnitSize

Gets the unit size of the components in the byte buffer, typically 1 for bytes and 2 for words.

public int UnitSize { get; }

Property Value

int

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

Create(IByteBuffer, Endian, int)

Creates a IByteBuffer accounting for endianness and unit size.

public static IByteBuffer Create(IByteBuffer buffer, Endian endian, int unitSize)

Parameters

buffer IByteBuffer

Original byte buffer.

endian Endian

Requested endianness.

unitSize int

Unit size of the individual components in the buffer.

Returns

IByteBuffer

If required given the endian of the local machine and the byte buffer unitSize, creates an instance of the EndianByteBuffer class, otherwise returns the original buffer.

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