Class StructBuilder<U>

Helper to build a base class that represents a TLV structure.

StructBuilder allows you to define the typing, constructor, encoder, and decoder, while writing each field only once. To be compatible with StructBuilder, the TLV structure being described shall contain a sequence of sub-TLV elements with distinct TLV-TYPE numbers, where each sub-TLV-TYPE appears zero, one, or multiple times.

To use StructBuilder, calling code should follow these steps:

  1. Invoke .add() method successively to define sub-TLV elements.
  2. Obtain a base class via .baseClass() method, which contains one field for each sub-TLV-TYPE as defined, along with constructor, encoding, and decoding functions.
  3. Declare a subclass deriving from this base class, to add more functionality.
  4. Assign the subclass constructor to .subclass property of the builder.

Type Parameters

  • U extends {}

Constructors

Properties

Accessors

Methods

Constructors

  • Constructor.

    Type Parameters

    • U extends {}

    Parameters

    • typeName: string

      Type name, used in error messages.

    • OptionaltopTT: number

      If specified, encode as complete TLV; otherwise, encode as TLV-VALUE only.

    Returns StructBuilder<U>

Properties

subclass?: Constructor<U, []>

Subclass constructor. This must be assigned, otherwise decoding function will not work.

topTT?: number

If specified, encode as complete TLV; otherwise, encode as TLV-VALUE only.

typeName: string

Type name, used in error messages.

Accessors

Methods