n3-lib TypeScript API
    Preparing search index...

    Class BinaryReader

    Bounded little-endian reader over a byte slice, including nonzero-offset views.

    Index
    bytes: Uint8Array

    Bytes owned by the caller; readers never mutate them.

    offset: number = 0

    Current byte position.

    • Read a nonnegative signed count and check its minimum storage before allocation.

      Parameters

      • maximum: number = 1_000_000
      • stride: number = 1

      Returns number

    • Require exact consumption; opaque tails must be explicitly modeled.

      Returns void

    • Read an IEEE-754 single-precision value; use u32 for exact NaN preservation.

      Returns number

    • Read an IEEE-754 double-precision value; use raw for exact NaN preservation.

      Returns number

    • Copy bytes from the next bounded range.

      Parameters

      • size: number

      Returns Uint8Array

    • Read original length-prefixed string bytes without normalizing or decoding.

      Parameters

      • maximum: number = 1_048_576

      Returns Uint8Array

    • Reserve a bounded range, returning its starting position.

      Parameters

      • size: number

      Returns number

    • Read an unsigned 32-bit integer; also preserves arbitrary f32 bit patterns.

      Returns number