Interface IByteSource
Byte source interface for reading operations.
Namespace: FellowOakDicom.IO
Assembly: fo-dicom.core.dll
Syntax
public interface IByteSourceProperties
Endian
Gets or sets the endianness.
Declaration
Endian Endian { get; set; }Property Value
| Type | Description |
|---|---|
| Endian |
IsEOF
Gets whether end-of-source is reached.
Declaration
bool IsEOF { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Position
Gets the current read position.
Declaration
long Position { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
Methods
GetBuffer(UInt32)
Gets a byte buffer of specified length from the current position and moves to subsequent position.
Declaration
IByteBuffer GetBuffer(uint count)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | count | Number of bytes to read. |
Returns
| Type | Description |
|---|---|
| IByteBuffer | Byte buffer containing the read bytes. |
GetBufferAsync(UInt32)
Asynchronously gets a byte buffer of specified length from the current position and moves to subsequent position.
Declaration
Task<IByteBuffer> GetBufferAsync(uint count)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | count | Number of bytes to read. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IByteBuffer> | Awaitable byte buffer containing the read bytes. |
GetBytes(Byte[], Int32, Int32)
Gets a specified number of bytes from the current position and moves to subsequent position.
The bytes will be written to buffer
Declaration
int GetBytes(byte[] buffer, int index, int count)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | buffer | The buffer to write the bytes to |
| System.Int32 | index | The index in the buffer at which to start writing |
| System.Int32 | count | Number of bytes to read. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The number of bytes that were filled in the buffer |
GetBytes(Int32)
Gets a specified number of bytes from the current position and moves to subsequent position.
Declaration
byte[] GetBytes(int count)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | count | Number of bytes to read. |
Returns
| Type | Description |
|---|---|
| System.Byte[] | Array of bytes. |
GetDouble()
Gets a double precision floating point value (64 bits) from the current position and moves to subsequent position.
Declaration
double GetDouble()Returns
| Type | Description |
|---|---|
| System.Double | Double precision floating point value. |
GetInt16()
Gets a signed short (16 bits) from the current position and moves to subsequent position.
Declaration
short GetInt16()Returns
| Type | Description |
|---|---|
| System.Int16 | Signed short. |
GetInt32()
Gets a signed integer (32 bits) from the current position and moves to subsequent position.
Declaration
int GetInt32()Returns
| Type | Description |
|---|---|
| System.Int32 | Signed integer. |
GetInt64()
Gets a signed long (64 bits) from the current position and moves to subsequent position.
Declaration
long GetInt64()Returns
| Type | Description |
|---|---|
| System.Int64 | Signed long. |
GetSingle()
Gets a single precision floating point value (32 bits) from the current position and moves to subsequent position.
Declaration
float GetSingle()Returns
| Type | Description |
|---|---|
| System.Single | Single precision floating point value. |
GetStream()
Get stream of this byte source.
Declaration
Stream GetStream()Returns
| Type | Description |
|---|---|
| System.IO.Stream | The stream. |
GetUInt16()
Gets an unsigned short (16 bits) from the current position and moves to subsequent position.
Declaration
ushort GetUInt16()Returns
| Type | Description |
|---|---|
| System.UInt16 | Unsigned short. |
GetUInt32()
Gets an unsigned integer (32 bits) from the current position and moves to subsequent position.
Declaration
uint GetUInt32()Returns
| Type | Description |
|---|---|
| System.UInt32 | Unsigned integer. |
GetUInt64()
Gets an unsigned long (64 bits) from the current position and moves to subsequent position.
Declaration
ulong GetUInt64()Returns
| Type | Description |
|---|---|
| System.UInt64 | Unsigned long. |
GetUInt8()
Gets one byte from the current position and moves to subsequent position.
Declaration
byte GetUInt8()Returns
| Type | Description |
|---|---|
| System.Byte | Single byte. |
GoTo(Int64)
Sets the current read position to the position position
Declaration
void GoTo(long position)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | position | the position to seek to |
Require(UInt32)
Verifies that there is a sufficient number of bytes to read.
Declaration
bool Require(uint count)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | count | Required number of bytes. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if source contains sufficient number of remaining bytes, false otherwise. |
Require(UInt32, ByteSourceCallback, Object)
Verifies that there is a sufficient number of bytes to read.
Declaration
bool Require(uint count, ByteSourceCallback callback, object state)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | count | Required number of bytes. |
| ByteSourceCallback | callback | Byte source callback. |
| System.Object | state | Callback state. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if source contains sufficient number of remaining bytes, false otherwise. |
Skip(UInt32)
Skip position count number of bytes.
Declaration
void Skip(uint count)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | count | Number of bytes to skip. |