Documentation
    Preparing search index...

    Class BcsWriter

    BCS data writer. Each instance owns its own encoder with independent state, so multiple writers never interfere with each other or with BcsType.serialize().

    Index

    Constructors

    • Parameters

      • Optional_options: BcsWriterOptions
      • Optionalenc: {
            buildEnumEncoder: (
                variantKeys: string[],
                variantWriters: (((v: unknown) => void) | null)[],
            ) => (v: unknown) => void;
            buildFixedArrayEncoder: (
                len: number,
                elemWriter: (v: unknown) => void,
                kind?: string,
            ) => (v: unknown) => void;
            buildMapEncoder: (
                keyWriter: (v: unknown) => void,
                valueWriter: (v: unknown) => void,
            ) => (v: unknown) => void;
            buildOptionEncoder: (
                innerWriter: (v: unknown) => void,
            ) => (v: unknown) => void;
            buildStructEncoder: (
                keys: string[],
                writers: ((v: unknown) => void)[],
            ) => (v: unknown) => void;
            buildTupleEncoder: (
                writers: ((v: unknown) => void)[],
            ) => (v: unknown) => void;
            buildVectorEncoder: (
                elemWriter: (v: unknown) => void,
                kind?: string,
            ) => (v: unknown) => void;
            bulkEncodeBool: (a: boolean[]) => void;
            bulkEncodeU16: (a: number[]) => void;
            bulkEncodeU32: (a: number[]) => void;
            bulkEncodeU64: (a: (string | number | bigint)[]) => void;
            bulkEncodeU8: (a: Uint8Array<ArrayBufferLike> | number[]) => void;
            encodeBool: (v: boolean) => void;
            encodeByteVector: (v: Iterable<number>) => void;
            encodeFixedBytes: (v: Iterable<number>, size: number) => void;
            encodeString: (v: string) => void;
            encodeU128: (v: string | number | bigint) => void;
            encodeU16: (v: number) => void;
            encodeU256: (v: string | number | bigint) => void;
            encodeU32: (v: number) => void;
            encodeU64: (v: string | number | bigint) => void;
            encodeU8: (v: number) => void;
            ensure: (n: number) => void;
            fastSerialize: (
                writeFn: (value: unknown) => void,
                value: unknown,
            ) => Uint8Array<ArrayBuffer>;
            getEncodeResult: () => Uint8Array<ArrayBuffer>;
            initEncode: () => void;
            writeRawBytes: (bytes: Uint8Array) => void;
            writeUleb: (n: number) => void;
            get offset(): number;
            set offset(v: number): void;
        }
        • buildEnumEncoder: (
              variantKeys: string[],
              variantWriters: (((v: unknown) => void) | null)[],
          ) => (v: unknown) => void
        • buildFixedArrayEncoder: (
              len: number,
              elemWriter: (v: unknown) => void,
              kind?: string,
          ) => (v: unknown) => void
        • buildMapEncoder: (
              keyWriter: (v: unknown) => void,
              valueWriter: (v: unknown) => void,
          ) => (v: unknown) => void
        • buildOptionEncoder: (innerWriter: (v: unknown) => void) => (v: unknown) => void
        • buildStructEncoder: (keys: string[], writers: ((v: unknown) => void)[]) => (v: unknown) => void
        • buildTupleEncoder: (writers: ((v: unknown) => void)[]) => (v: unknown) => void
        • buildVectorEncoder: (elemWriter: (v: unknown) => void, kind?: string) => (v: unknown) => void
        • bulkEncodeBool: (a: boolean[]) => void
        • bulkEncodeU16: (a: number[]) => void
        • bulkEncodeU32: (a: number[]) => void
        • bulkEncodeU64: (a: (string | number | bigint)[]) => void
        • bulkEncodeU8: (a: Uint8Array<ArrayBufferLike> | number[]) => void
        • encodeBool: (v: boolean) => void
        • encodeByteVector: (v: Iterable<number>) => void
        • encodeFixedBytes: (v: Iterable<number>, size: number) => void
        • encodeString: (v: string) => void
        • encodeU128: (v: string | number | bigint) => void
        • encodeU16: (v: number) => void
        • encodeU256: (v: string | number | bigint) => void
        • encodeU32: (v: number) => void
        • encodeU64: (v: string | number | bigint) => void
        • encodeU8: (v: number) => void
        • ensure: (n: number) => void
        • fastSerialize: (writeFn: (value: unknown) => void, value: unknown) => Uint8Array<ArrayBuffer>
        • getEncodeResult: () => Uint8Array<ArrayBuffer>
        • initEncode: () => void
        • writeRawBytes: (bytes: Uint8Array) => void
        • writeUleb: (n: number) => void
        • get offset(): number
        • set offset(v: number): void

      Returns BcsWriter

    Accessors

    • get bytePosition(): number

      Returns number

    Methods

    • Returns Iterator<number, Iterable<number, any, any>>

    • Parameters

      • bytes: number

      Returns this

    • Parameters

      • bytes: number

      Returns this

    • Returns Uint8Array<ArrayBuffer>

    • Parameters

      Returns string

    • Parameters

      • value: number | bigint

      Returns this

    • Parameters

      • value: number | bigint

      Returns this

    • Parameters

      • value: number | bigint

      Returns this

    • Parameters

      • value: number | bigint

      Returns this

    • Parameters

      • value: number | bigint

      Returns this

    • Parameters

      • value: number | bigint

      Returns this

    • Parameters

      • bytes: Uint8Array

      Returns this

    • Parameters

      • value: number

      Returns this

    • Parameters

      • vector: any[]
      • cb: (writer: BcsWriter, el: any, i: number, len: number) => void

      Returns this