Class UnionLayoutDiscriminator

An object that can provide a discriminator API for Union using an unsigned integral Layout instance located either inside or outside the union.

param layout: initializes {@link UnionLayoutDiscriminator#layout|layout}. Must satisfy {@link ExternalLayout#isCount|isCount()}.
param [property]: Default for {@link UnionDiscriminator#property|property}, superseding the property from layout, but defaulting to variant if neither property nor layout provide a property name.

Hierarchy

UnionDiscriminator<number>
- UnionLayoutDiscriminator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UnionLayoutDiscriminator(layout: ExternalLayout, property?: string): UnionLayoutDiscriminator

Overrides UnionDiscriminator.constructor
- Defined in Layout.ts:1345
Parameters
- layout: ExternalLayout
- Optional property: string
Returns UnionLayoutDiscriminator

Properties

layout

layout: ExternalLayout

property

property: string

Methods

decode

decode(b: Uint8Array, offset?: number): number

Overrides UnionDiscriminator.decode
- Defined in Layout.ts:1359
Delegate decoding to {@link UnionLayoutDiscriminator#layout|layout}.

Parameters
- b: Uint8Array
- Optional offset: number
Returns number

encode

encode(src: number, b: Uint8Array, offset?: number): number

Overrides UnionDiscriminator.encode
- Defined in Layout.ts:1364
Delegate encoding to {@link UnionLayoutDiscriminator#layout|layout}.

Parameters
- src: number
- b: Uint8Array
- Optional offset: number
Returns number

Generated using TypeDoc