Class Descriptor<T, V>

Readonlydecode

Readonlyencode

Readonlyname

ReadonlysizeHint

Readonlyskip

ReadonlyView

asOpaque

• asOpaque<R>(): Descriptor<pvm.Opaque<T, pvm.TokenOf<R, T>>, V>

  Safely cast the descriptor value to a opaque type.

  Type Parameters

  • R

  Returns Descriptor<pvm.Opaque<T, pvm.TokenOf<R, T>>, V>

convert

• convert<F>(input: (i: F) => T, output: (i: T) => F): Descriptor<F, V>

  Return a new descriptor that converts data into some other type.

  Type Parameters

  • F

  Parameters

  • input: (i: F) => T
  • output: (i: T) => F

  Returns Descriptor<F, V>

skipEncoded

• skipEncoded(decoder: Decoder): BytesBlob

  Extract an encoded version of this type from the decoder.

  This function skips the object instead of decoding it, allowing to retrieve the encoded portion of the object from Decoder.

  Parameters

  • decoder: Decoder

  Returns BytesBlob

Staticnew

• new<T>(
      name: string,
      sizeHint: SizeHint,
      encode: (e: Encoder, elem: T) => void,
      decode: (d: Decoder) => T,
      skip: (s: Skipper) => void,
  ): Descriptor<T, T>

  Create a new descriptor without a specialized View.

  Type Parameters

  • T

  Parameters

  • name: string
  • sizeHint: SizeHint
  • encode: (e: Encoder, elem: T) => void
  • decode: (d: Decoder) => T
  • skip: (s: Skipper) => void

  Returns Descriptor<T, T>

StaticwithView

• withView<T, V>(
      name: string,
      sizeHint: SizeHint,
      encode: (e: Encoder, elem: T) => void,
      decode: (d: Decoder) => T,
      skip: (s: Skipper) => void,
      view: Descriptor<V>,
  ): Descriptor<T, V>

  New descriptor with specialized View.

  Type Parameters

  • T
  • V

  Parameters

  • name: string
  • sizeHint: SizeHint
  • encode: (e: Encoder, elem: T) => void
  • decode: (d: Decoder) => T
  • skip: (s: Skipper) => void
  • view: Descriptor<V>

  Returns Descriptor<T, V>