@quack-protocol/sdk - v0.1.0
    Preparing search index...

    Class BinaryReader

    Reader for DuckDB BinarySerializer-compatible primitive values.

    Index

    Constructors

    Accessors

    • get position(): number

      Current byte offset in the input.

      Returns number

    • get remaining(): number

      Number of unread bytes remaining.

      Returns number

    Methods

    • Throw if any bytes remain unread.

      Returns void

    • Whether the reader has consumed all input bytes.

      Returns boolean

    • Peek at the next field id without advancing the reader.

      Returns number

    • Read a length-prefixed binary blob.

      Returns Uint8Array

    • Read a DuckDB boolean byte.

      Returns boolean

    • Read raw bytes without interpreting a length prefix.

      Parameters

      • length: number

      Returns Uint8Array

    • Read and validate an end-of-object marker.

      Returns void

    • Read a raw 16-bit BinarySerializer field id.

      Returns number

    • Read a fixed-width 32-bit little-endian float.

      Returns number

    • Read a fixed-width 64-bit little-endian float.

      Returns number

    • Read a fixed-width signed 16-bit little-endian integer.

      Returns number

    • Read a fixed-width signed 32-bit little-endian integer.

      Returns number

    • Read a fixed-width signed 64-bit little-endian integer.

      Returns bigint

    • Read a fixed-width signed 8-bit integer.

      Returns number

    • Read a fixed-width unsigned 16-bit little-endian integer.

      Returns number

    • Read a fixed-width unsigned 32-bit little-endian integer.

      Returns number

    • Read a fixed-width unsigned 64-bit little-endian integer.

      Returns bigint

    • Read a fixed-width unsigned 8-bit integer.

      Returns number

    • Read a length-prefixed list.

      Type Parameters

      • T

      Parameters

      • readElement: (index: number) => T

      Returns T[]

    • Read a nullable pointer-style value.

      Type Parameters

      • T

      Parameters

      • readValue: () => T

      Returns T | undefined

    • Read an optional field when the next field id matches.

      Type Parameters

      • T

      Parameters

      • fieldId: number
      • read: () => T
      • defaultValue: T

      Returns T

    • Read a required field with the expected field id.

      Type Parameters

      • T

      Parameters

      • fieldId: number
      • read: () => T

      Returns T

    • Read a signed LEB128 integer as bigint.

      Returns bigint

    • Read a signed LEB128 integer as a safe JavaScript number.

      Returns number

    • Read a UTF-8 string with a length prefix.

      Returns string

    • Read length-prefixed bytes for a string-like value.

      Returns Uint8Array

    • Read an unsigned LEB128 integer as bigint.

      Returns bigint

    • Read an unsigned LEB128 integer as a safe JavaScript number.

      Returns number