Class BinaryRecordStep<RECORD, ENTRY_ARGS, ENTRY_TYPE>

a pure binary step is a class capable of encoding and decoding binary data without the lose of invertibility information during either transformations.

the forward method behaves like a decoder
the backward method behaves like an encoder

Type Parameters

RECORD
the value type of the decoded object
ENTRY_ARGS extends {
[K in keyof RECORD]?: any
} = {
[K in keyof RECORD]?: any
}
the input argument interface needed for decoding in the forward method (could be empty)
ENTRY_TYPE extends RecordEntry_KeyStepTuple<RECORD> = RecordEntry_KeyStepTuple<RECORD>

Hierarchy (view full)

BinaryPureStep<RECORD, RecordArgs<ENTRY_ARGS>>
- BinaryRecordStep

Index

Constructors

constructor

new BinaryRecordStep<RECORD, ENTRY_ARGS, ENTRY_TYPE>(entries): BinaryRecordStep<RECORD, ENTRY_ARGS, ENTRY_TYPE>
Type Parameters
- RECORD
- ENTRY_ARGS extends {
  [K in string | number | symbol]?: any
  } = {
  [K in string | number | symbol]?: any
  }
- ENTRY_TYPE = RecordEntry_KeyStepTuple<RECORD>
Parameters
- entries: ENTRY_TYPE[]
Returns BinaryRecordStep<RECORD, ENTRY_ARGS, ENTRY_TYPE>
Overrides BinaryPureStep.constructor
- Defined in binary_composition_steps.ts:144

Properties

`Protected` `Readonly` entry_steps

entry_steps: ENTRY_TYPE[]

`Protected` lost

lost: never

information lost in the forward transformation should be stored here. the lost information may be needed for the backward transformation.

Methods

forward

forward(input): BinaryOutput<RECORD>
the forward transformation function
Parameters
- input: BinaryInput<ENTRY_ARGS>
Returns BinaryOutput<RECORD>
Overrides BinaryPureStep.forward
- Defined in binary_composition_steps.ts:148

`Protected` partial_forward

partial_forward(bin, pos, args, start?, end?): BinaryOutput<Partial<RECORD>>
Parameters
- bin: Uint8Array
- pos: number
- args: Partial<ENTRY_ARGS>
- start: number = 0
- Optional end: number
Returns BinaryOutput<Partial<RECORD>>
- Defined in binary_composition_steps.ts:152

backward

backward(input): BinaryInput<ENTRY_ARGS>
Parameters
- input: Omit<BinaryOutput<RECORD>, "len">
Returns BinaryInput<ENTRY_ARGS>
Inherit Doc: the
backward transformation in the BinaryStep is defined so that it is not reliant the decoded object's original bytelength len member.
Overrides BinaryPureStep.backward
- Defined in binary_composition_steps.ts:167

`Protected` partial_backward

partial_backward(val, start?, end?): {
bins: Uint8Array[];
args: Partial<ENTRY_ARGS>;
}
Parameters
- val: Partial<RECORD>
- start: number = 0
- Optional end: number
Returns {
bins: Uint8Array[];
args: Partial<ENTRY_ARGS>;
}
- bins: Uint8Array[]
- args: Partial<ENTRY_ARGS>
- Defined in binary_composition_steps.ts:175

Class BinaryRecordStep<RECORD, ENTRY_ARGS, ENTRY_TYPE>

Type Parameters

RECORD

ENTRY_ARGS extends { [K in keyof RECORD]?: any} = { [K in keyof RECORD]?: any}

ENTRY_TYPE extends RecordEntry_KeyStepTuple<RECORD> = RecordEntry_KeyStepTuple<RECORD>

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

RECORD

ENTRY_ARGS extends { [K in string | number | symbol]?: any} = { [K in string | number | symbol]?: any}

ENTRY_TYPE = RecordEntry_KeyStepTuple<RECORD>

Parameters

entries: ENTRY_TYPE[]

Returns BinaryRecordStep<RECORD, ENTRY_ARGS, ENTRY_TYPE>

Properties

Protected Readonly entry_steps

Protected lost

Methods

forward

Parameters

input: BinaryInput<ENTRY_ARGS>

Returns BinaryOutput<RECORD>

Protected partial_forward

Parameters

bin: Uint8Array

pos: number

args: Partial<ENTRY_ARGS>

start: number = 0

Optional end: number

Returns BinaryOutput<Partial<RECORD>>

backward

Parameters

input: Omit<BinaryOutput<RECORD>, "len">

Returns BinaryInput<ENTRY_ARGS>

Inherit Doc: the

Protected partial_backward

Parameters

val: Partial<RECORD>

start: number = 0

Optional end: number

Returns { bins: Uint8Array[]; args: Partial<ENTRY_ARGS>; }

bins: Uint8Array[]

args: Partial<ENTRY_ARGS>

Settings

Member Visibility

Theme

On This Page

ENTRY_ARGS extends {
[K in keyof RECORD]?: any
} = {
[K in keyof RECORD]?: any
}

ENTRY_ARGS extends {
[K in string | number | symbol]?: any
} = {
[K in string | number | symbol]?: any
}

`Protected` `Readonly` entry_steps

`Protected` lost

`Protected` partial_forward

`Optional` end: number

`Protected` partial_backward

`Optional` end: number

Returns {
bins: Uint8Array[];
args: Partial<ENTRY_ARGS>;
}