multipaz/org.multipaz.util/ByteDataReader

ByteDataReader

class ByteDataReader(val byteArray: ByteArray)

This class provides methods for reading various data types from a byte array ByteArray.

It maintains an internal cursor that indicates the current reading position within the byte array. The peek...() methods allow reading data without moving the cursor, while the get...() methods read and advance the cursor.

Parameters

byteArray

The byte array to read from.

Constructors

ByteDataReader

constructor(byteString: ByteString)

Creates a ByteDataReader with a given ByteString.

constructor(byteArray: ByteArray)

Creates a ByteDataReader with a given byte array.

Properties

byteArray

val byteArray: ByteArray

Functions

exhausted

fun exhausted(): Boolean

Checks if the end of the byte array has been reached.

getByteString

fun getByteString(numBytes: Int): ByteString

Reads a ByteString from the byte array and advances the cursor.

getInt16

fun getInt16(): Short

Reads an Int16 value from the byte array and advances the cursor.

getInt16Le

fun getInt16Le(): Short

Reads an Int16 value in little-endian order from the byte array and advances the cursor.

getInt32

fun getInt32(): Int

Reads an Int32 value from the byte array and advances the cursor.

getInt32Le

fun getInt32Le(): Int

Reads an Int32 value in little-endian order from the byte array and advances the cursor.

getInt64

fun getInt64(): Long

Reads an Int64 value from the byte array and advances the cursor.

getInt64Le

fun getInt64Le(): Long

Reads an Int64 value in little-endian order from the byte array and advances the cursor.

getInt8

fun getInt8(): Byte

Reads an Int8 value from the byte array and advances the cursor.

getString

fun getString(numBytes: Int): String

Reads a String from the byte array and advances the cursor.

getUInt16

fun getUInt16(): UShort

Reads a UInt16 value from the byte array and advances the cursor.

getUInt16Le

fun getUInt16Le(): UShort

Reads a UInt16 value in little-endian order from the byte array and advances the cursor.

getUInt32

fun getUInt32(): UInt

Reads a UInt32 value from the byte array and advances the cursor.

getUInt32Le

fun getUInt32Le(): UInt

Reads a UInt32 value in little-endian order from the byte array and advances the cursor.

getUInt64

fun getUInt64(): ULong

Reads a UInt64 value from the byte array and advances the cursor.

getUInt64Le

fun getUInt64Le(): ULong

Reads a UInt64 value in little-endian order from the byte array and advances the cursor.

getUInt8

fun getUInt8(): UByte

Reads a UInt8 value from the byte array and advances the cursor.

numBytesRemaining

fun numBytesRemaining(): Int

Gets the number of bytes remaining to be read from the current cursor position.

peekByteString

fun peekByteString(numBytes: Int): ByteString

Reads a ByteString from the byte array without advancing the cursor.

peekInt16

fun peekInt16(): Short

Reads an Int16 value from the byte array without advancing the cursor.

peekInt16Le

fun peekInt16Le(): Short

Reads an Int16 value in little-endian order from the byte array without advancing the cursor.

peekInt32

fun peekInt32(): Int

Reads an Int32 value from the byte array without advancing the cursor.

peekInt32Le

fun peekInt32Le(): Int

Reads an Int32 value in little-endian order from the byte array without advancing the cursor.

peekInt64

fun peekInt64(): Long

Reads an Int64 value from the byte array without advancing the cursor.

peekInt64Le

fun peekInt64Le(): Long

Reads an Int64 value in little-endian order from the byte array without advancing the cursor.

peekInt8

fun peekInt8(): Byte

Reads an Int8 value from the byte array without advancing the cursor.

peekString

fun peekString(numBytes: Int): String

Reads a String from the byte array without advancing the cursor.

peekUInt16

fun peekUInt16(): UShort

Reads a UInt16 value from the byte array without advancing the cursor.

peekUInt16Le

fun peekUInt16Le(): UShort

Reads a UInt16 value in little-endian order from the byte array without advancing the cursor.

peekUInt32

fun peekUInt32(): UInt

Reads a UInt32 value from the byte array without advancing the cursor.

peekUInt32Le

fun peekUInt32Le(): UInt

Reads a UInt32 value in little-endian order from the byte array without advancing the cursor.

peekUInt64

fun peekUInt64(): ULong

Reads a UInt64 value from the byte array without advancing the cursor.

peekUInt64Le

fun peekUInt64Le(): ULong

Reads a UInt64 value in little-endian order from the byte array without advancing the cursor.

peekUInt8

fun peekUInt8(): UByte

Reads a UInt8 value from the byte array without advancing the cursor.

skip

fun skip(numBytes: Int): ByteDataReader

Skips a specified number of bytes in the byte array.