Thruput TypeScript protocol bindings
    Preparing search index...

    Interface IReader

    Reads primitive values from an XDR-compatible serialization format.

    interface IReader {
        position: number;
        remaining: number;
        readBool(): boolean;
        readFixedOpaque(len: number): Uint8Array;
        readInt128(): bigint;
        readInt32(): bigint;
        readInt64(): bigint;
        readString(max: number): string;
        readUint128(): bigint;
        readUint32(): bigint;
        readUint64(): bigint;
        readVarOpaque(max: number): Uint8Array;
    }

    Implemented by

    Index

    Properties

    position remaining

    Methods

    readBool readFixedOpaque readInt128 readInt32 readInt64 readString readUint128 readUint32 readUint64 readVarOpaque

    Properties

    position: number

    Current byte offset in the input.

    remaining: number

    Number of unread bytes remaining in the input.

    Methods

    • Read a boolean value.

      Returns boolean

    • Read exactly len opaque bytes into a caller-owned copy.

      Parameters

      • len: number

      Returns Uint8Array

    • Read a signed 128-bit integer.

      Returns bigint

    • Read a signed 32-bit integer.

      Returns bigint

    • Read a signed 64-bit integer.

      Returns bigint

    • Read and UTF-8 decode a length-prefixed string bounded by max bytes.

      Parameters

      • max: number

      Returns string

    • Read an unsigned 128-bit integer.

      Returns bigint

    • Read an unsigned 32-bit integer.

      Returns bigint

    • Read an unsigned 64-bit integer.

      Returns bigint

    • Read length-prefixed opaque bytes bounded by max into a caller-owned copy.

      Parameters

      • max: number

      Returns Uint8Array

    Settings

    Member Visibility

    On This Page

    Properties
    Methods