Options
All
  • Public
  • Public/Protected
  • All
Menu

Contain a fixed-length block of arbitrary data, represented as a Uint8Array.

Factory: {@link module:Layout.blob|blob}

param length

initializes {@link Blob#length|length}.

param [property]

initializer for {@link Layout#property|property}.

Hierarchy

Index

Constructors

constructor

Properties

Optional boundConstructor_

boundConstructor_?: any

length

length: number | ExternalLayout

Optional property

property?: string

span

span: number

Methods

decode

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

encode

  • encode(src: Uint8Array, b: Uint8Array, offset: number): number
  • Implement {@link Layout#encode|encode} for Blob.

    NOTE If {@link Layout#count|count} is an instance of ExternalLayout then the length of src will be encoded as the count after src is encoded.

    Parameters

    • src: Uint8Array
    • b: Uint8Array
    • offset: number

    Returns number

fromArray

  • Create an object from layout properties and an array of values.

    NOTE This function returns undefined if invoked on a layout that does not return its value as an Object. Objects are returned for things that are a Structure, which includes variant layouts if they are structures, and excludes Unions. If you want this feature for a union you must use getVariant to select the desired layout.

    Parameters

    • values: any[]

      an array of values that correspond to the default order for properties. As with {@link Layout#decode|decode} layout elements that have no property name are skipped when iterating over the array values. Only the top-level properties are assigned; arguments are not assigned to properties of contained layouts. Any unused values are ignored.

    Returns undefined | LayoutObject

getSpan

  • getSpan(b: Uint8Array, offset?: number): number

makeDestinationObject

replicate

  • replicate(property: string): Blob
  • Replicate the layout using a new property.

    This function must be used to get a structurally-equivalent layout with a different name since all Layout instances are immutable.

    NOTE This is a shallow copy. All fields except {@link Layout#property|property} are strictly equal to the origin layout.

    Parameters

    • property: string

      the value for {@link Layout#property|property} in the replica.

    Returns Blob

    • the copy with {@link Layout#property|property} set to property.

Generated using TypeDoc