Class CborReader

A stateful, forward-only reader for Concise Binary Object Representation (CBOR) encoded data.

Hierarchy

CborReader

Index

Constructors

constructor

new CborReader(data: HexBlob): Serialization.CborReader
Initializes a CborReader instance over the specified data with the given configuration.
Parameters
- data: HexBlob
  
  The CBOR encoded data to read.
Returns Serialization.CborReader
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:39

Properties

`Private` #cachedState

#cachedState: Serialization.CborReaderState = CborReaderState.Undefined

`Private` #currentFrame

#currentFrame: StackFrame

`Private` `Readonly` #data

#data: Uint8Array

`Private` #isTagContext

#isTagContext: boolean = false

`Private` #nestedItems

#nestedItems: StackFrame[] = ...

`Private` #offset

#offset: number = 0

Methods

`Private` #advanceBuffer

#advanceBuffer(length: number): void
Advances the buffer pointer.
Parameters
- length: number
  
  The number of bytes to advance the buffer.
Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:647

`Private` #advanceDataItemCounters

#advanceDataItemCounters(): void
Advances the data item counters.

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:637

`Private` #ensureReadCapacity

#ensureReadCapacity(bytesToRead: number): void
Asserts that there are enough bytes remaining in the buffer to read the give amount of bytes.
Parameters
- bytesToRead: number
  
  The number of bytes to read.
Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:658

`Private` #getRemainingBytes

#getRemainingBytes(): Uint8Array
Gets the remaining bytes in the buffer.

Returns
An array with the remaining bytes in the buffer.

Returns Uint8Array
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:632

`Private` #peekInitialByte

#peekInitialByte(expectedType?: CborMajorType): CborInitialByte
Peeks the next initial byte without advancing the data stream.

Returns
The next initial byte.
Parameters
- Optional expectedType: CborMajorType
  
  If an expected type is given, the method will throw in the event of a major type mismatch.
Returns CborInitialByte
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:493

`Private` #peekSignedInteger

#peekSignedInteger(): {
bytesRead: number;
signedInt: bigint;
}
Peeks a signed integer from the data stream.

Returns
An object with the signed int and the bytes read.

Returns {
bytesRead: number;
signedInt: bigint;
}
- bytesRead: number
- signedInt: bigint
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:841

`Private` #peekStateCore

#peekStateCore(): Serialization.CborReaderState
Reads the next CBOR token, without advancing the reader.

Returns
An object that represents the current CBOR reader state.

Returns Serialization.CborReaderState
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:682

`Private` #peekTagCore

#peekTagCore(): {
bytesRead: number;
tag: Serialization.CborTag;
}
Peeks the core tag.

Returns
the Core tag and the bytes that would be consumed from the stream.

Returns {
bytesRead: number;
tag: Serialization.CborTag;
}
- bytesRead: number
- tag: Serialization.CborTag
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:906

`Private` #peekUnsignedInteger

#peekUnsignedInteger(): {
bytesRead: number;
unsignedInt: bigint;
}
Peeks an unsigned integer from the data stream.

Returns
An object with the unsigned int and the bytes read.

Returns {
bytesRead: number;
unsignedInt: bigint;
}
- bytesRead: number
- unsignedInt: bigint
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:819

`Private` #popDataItem

#popDataItem(expectedType: CborMajorType): void
Goes one level up on the stack.
Parameters
- expectedType: CborMajorType
  
  The expected major type.
Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:591

`Private` #pushDataItem

#pushDataItem(majorType: CborMajorType, definiteLength?: number): void
Goes one level down into the stack.
Parameters
- majorType: CborMajorType
  
  The current major type.
- Optional definiteLength: number
  
  The definite length of the current type (if applicable).
Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:567

`Private` #readIndefiniteLengthByteStringConcatenated

#readIndefiniteLengthByteStringConcatenated(type: CborMajorType): {
encodingLength: number;
val: Uint8Array;
}
Reads the contents of a indefinite length bytearray or text and returns all the chunks concatenated.

Returns
The concatenated array.
Parameters
- type: CborMajorType
  
  The type of the indefinite array.
Returns {
encodingLength: number;
val: Uint8Array;
}
- encodingLength: number
- val: Uint8Array
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:873

`Private` #restoreStackFrame

#restoreStackFrame(frame: StackFrame): void
Restores the stack after popping the current stack frame.
Parameters
- frame: StackFrame
  
  the stack frame.
Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:618

`Private` #skipNextNode

#skipNextNode(initialDepth: number): number
Skips the next item in the current nested level

Returns
the depth after the node has been skipped.
Parameters
- initialDepth: number
  
  The starting depth.
Returns number
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:972

`Private` #validateNextByteIsBreakByte

#validateNextByteIsBreakByte(): void
Checks whether the next initial byte is a break byte.

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:554

getBytesRemaining

getBytesRemaining(): number
Gets the total number of unread bytes in the buffer.

Returns
The total number of unread bytes in the buffer.

Returns number
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:65

peekState

peekState(): Serialization.CborReaderState
Reads the next CBOR token, without advancing the reader.

Returns
The current CBOR reader state.

Returns Serialization.CborReaderState
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:54

peekTag

peekTag(): Serialization.CborTag
Reads the next data item as a semantic tag (major type 6), without advancing the reader.

Returns
The decoded value.

Returns Serialization.CborTag
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:479

readBoolean

readBoolean(): boolean
Reads the next data item as a boolean value (major type 7).

Returns
The decoded value.

Returns boolean
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:290

readByteString

readByteString(): Uint8Array
Reads the next data item as a byte string (major type 2).

Returns
The decoded byte array.

Remark: The method accepts indefinite length strings, which it concatenates to a single string.

Returns Uint8Array
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:343

readCborNegativeIntegerRepresentation

readCborNegativeIntegerRepresentation(): bigint
Reads the next data item as a CBOR negative integer representation (major type 1).

Returns
An unsigned integer denoting -1 minus the integer.

Returns bigint
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:225

readDefiniteLengthByteString

readDefiniteLengthByteString(): Uint8Array
Reads the next data item as a byte string (major type 2).

Returns
The decoded byte array.

Remark: The method accepts indefinite length strings, which it concatenates to a single string.

Returns Uint8Array
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:372

readDefiniteLengthTextString

readDefiniteLengthTextString(): string
Reads the next data item as a UTF-8 text string (major type 3).

Returns
The decoded string.

Remark: The method accepts indefinite length strings, which it concatenates to a single string.

Returns string
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:444

readDouble

readDouble(): number
Reads the next data item as a double-precision floating point number (major type 7).

Returns
The decoded double value.

Returns number
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:153

readEncodedValue

readEncodedValue(): Uint8Array
Reads the next CBOR data item, returning a subarray with the encoded value. For indefinite length encodings this includes the break byte.

Returns
A subarray with the encoded value as a contiguous region of memory.

Returns Uint8Array
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:80

readEndArray

readEndArray(): void
Reads the end of an array (major type 4).

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:112

readEndIndefiniteLengthByteString

readEndIndefiniteLengthByteString(): void
Ends reading an indefinite-length byte string (major type 2).

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:329

readEndIndefiniteLengthTextString

readEndIndefiniteLengthTextString(): void
Ends reading an indefinite-length UTF-8 text string (major type 3).

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:401

readEndMap

readEndMap(): void
Reads the end of a map (major type 5).

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:270

readInt

readInt(): bigint
Reads the next data item as a signed integer (major types 0,1).

Returns
The decoded integer value.

Returns bigint
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:129

readNull

readNull(): void
Reads the next data item as a null value (major type 7).

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:306

readSimpleValue

readSimpleValue(): Serialization.CborSimpleValue
Reads the next data item as a CBOR simple value (major type 7).

Returns
The decoded CBOR simple value.

Returns Serialization.CborSimpleValue
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:196

readStartArray

readStartArray(): null | number
Reads the next data item as the start of an array (major type 4).

Returns null | number
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:94

readStartIndefiniteLengthByteString

readStartIndefiniteLengthByteString(): void
Reads the next data item as the start of an indefinite-length byte string (major type 2).

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:318

readStartIndefiniteLengthTextString

readStartIndefiniteLengthTextString(): void
Reads the next data item as the start of an indefinite-length UTF-8 text string (major type 3).

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:390

readStartMap

readStartMap(): null | number
Reads the next data item as the start of a map (major type 5).

Returns
The number of key-value pairs in a definite-length map, or null if the map is indefinite-length.

remark: Map contents are consumed as if they were arrays twice the length of the map's declared size.

For example, a map of size 1 containing a key of type int with a value of type string must be consumed by successive calls to readInt32 and readTextString.

Returns null | number
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:243

readTag

readTag(): Serialization.CborTag
Reads the next data item as a semantic tag (major type 6), without advancing the reader.

Returns
The decoded value.

Returns Serialization.CborTag
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:466

readTextString

readTextString(): string
Reads the next data item as a UTF-8 text string (major type 3).

Returns
The decoded string.

Remark: The method accepts indefinite length strings, which it concatenates to a single string.

Returns string
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:415

readUInt

readUInt(): bigint
Reads the next data item as an unsigned integer (major type 0).

Returns
The decoded integer value.

Returns bigint
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:141

skipValue

skipValue(): void
Skips the next CBOR data item and advance the reader. For indefinite length encodings this includes the break byte.

Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:70

`Static` `Private` #decodeUnsignedInteger

#decodeUnsignedInteger(header: CborInitialByte, data: Uint8Array): {
bytesRead: number;
unsignedInt: bigint;
}
Decodes an unsigned integer.

https://tools.ietf.org/html/rfc7049#section-2.1
Parameters
- header: CborInitialByte
  
  The header byte.
- data: Uint8Array
  
  the data.
Returns {
bytesRead: number;
unsignedInt: bigint;
}
- bytesRead: number
- unsignedInt: bigint
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:921

`Static` `Private` #peekDefiniteLength

#peekDefiniteLength(header: CborInitialByte, data: Uint8Array): {
bytesRead: number;
length: number;
}
Peeks the definite length for given data item.

Returns
An object with the definite length and the bytes read.
Parameters
- header: CborInitialByte
  
  The initial byte header.
- data: Uint8Array
  
  The data stream.
Returns {
bytesRead: number;
length: number;
}
- bytesRead: number
- length: number
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:809

`Static` `Private` #peekNextInitialByte

#peekNextInitialByte(buffer: Uint8Array, expectedType?: CborMajorType): CborInitialByte
Peeks the next initial byte without advancing the data stream.

Returns
The next initial byte.
Parameters
- buffer: Uint8Array
  
  the buffer where to get the initial byte from.
- Optional expectedType: CborMajorType
  
  If an expected type is given, the method will throw in the event of a major type mismatch.
Returns CborInitialByte
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:543

`Static` ensureReadCapacityInArray

ensureReadCapacityInArray(data: Uint8Array, bytesToRead: number): void
Asserts that there are enough bytes remaining in the buffer to read the give amount of bytes.
Parameters
- data: Uint8Array
  
  The array to read the bytes from.
- bytesToRead: number
  
  The number of bytes to read.
Returns void
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:670

`Static` mapSimpleValueDataToReaderState

mapSimpleValueDataToReaderState(value: Serialization.CborAdditionalInfo): Serialization.CborReaderState
Maps simple value data to reader state.
Parameters
- value: Serialization.CborAdditionalInfo
  
  The value.
Returns Serialization.CborReaderState
- Defined in packages/core/src/Serialization/CBOR/CborReader.ts:783

Class CborReader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: HexBlob

Returns Serialization.CborReader

Properties

Private #cachedState

Private #currentFrame

Private Readonly #data

Private #isTagContext

Private #nestedItems

Private #offset

Methods

Private #advanceBuffer

Parameters

length: number

Returns void

Private #advanceDataItemCounters

Returns void

Private #ensureReadCapacity

Parameters

bytesToRead: number

Returns void

Private #getRemainingBytes

Returns

Returns Uint8Array

Private #peekInitialByte

Returns

Parameters

Optional expectedType: CborMajorType

Returns CborInitialByte

Private #peekSignedInteger

Returns

Returns { bytesRead: number; signedInt: bigint; }

bytesRead: number

signedInt: bigint

Private #peekStateCore

Returns

Returns Serialization.CborReaderState

Private #peekTagCore

Returns

Returns { bytesRead: number; tag: Serialization.CborTag; }

bytesRead: number

tag: Serialization.CborTag

Private #peekUnsignedInteger

Returns

Returns { bytesRead: number; unsignedInt: bigint; }

bytesRead: number

unsignedInt: bigint

Private #popDataItem

Parameters

expectedType: CborMajorType

Returns void

Private #pushDataItem

Parameters

majorType: CborMajorType

Optional definiteLength: number

Returns void

Private #readIndefiniteLengthByteStringConcatenated

Returns

Parameters

type: CborMajorType

Returns { encodingLength: number; val: Uint8Array; }

encodingLength: number

val: Uint8Array

Private #restoreStackFrame

Parameters

frame: StackFrame

Returns void

Private #skipNextNode

Returns

Parameters

initialDepth: number

Returns number

`Private` #cachedState

`Private` #currentFrame

`Private` `Readonly` #data

`Private` #isTagContext

`Private` #nestedItems

`Private` #offset

`Private` #advanceBuffer

`Private` #advanceDataItemCounters

`Private` #ensureReadCapacity

`Private` #getRemainingBytes

`Private` #peekInitialByte

`Optional` expectedType: CborMajorType

`Private` #peekSignedInteger

Returns {
bytesRead: number;
signedInt: bigint;
}

`Private` #peekStateCore

`Private` #peekTagCore

Returns {
bytesRead: number;
tag: Serialization.CborTag;
}

`Private` #peekUnsignedInteger

Returns {
bytesRead: number;
unsignedInt: bigint;
}

`Private` #popDataItem

`Private` #pushDataItem

`Optional` definiteLength: number

`Private` #readIndefiniteLengthByteStringConcatenated

Returns {
encodingLength: number;
val: Uint8Array;
}

`Private` #restoreStackFrame

`Private` #skipNextNode

`Private` #validateNextByteIsBreakByte

`Static` `Private` #decodeUnsignedInteger