Class BitReader

a bit reader that reads bits from a byte-aligned stream

Implements

ISyncReadable

Index

Constructors

Accessors

bitPosition isAligned

Methods

align readBits readBitsBig readSync skipBits

Constructors

constructor

new BitReader(readable: ISyncReadable): BitReader
Parameters
- readable: ISyncReadable
  fuman readable stream
Returns BitReader
- Defined in packages/io/src/bits/reader.ts:12

Accessors

bitPosition

get bitPosition(): number
The current bit position within the last consumed byte

Returns number
- Defined in packages/io/src/bits/reader.ts:27

isAligned

get isAligned(): boolean
Whether the reader is currently aligned on a byte boundary

Returns boolean
- Defined in packages/io/src/bits/reader.ts:17

Methods

align

align(): void
Skip any remaining bits in the current byte. No-op if already aligned

Returns void
- Defined in packages/io/src/bits/reader.ts:22

readBits

readBits(size: number): number
read a number of bits from the stream, and return them as a number
Parameters
- size: number
Returns number
- Defined in packages/io/src/bits/reader.ts:62

readBitsBig

readBitsBig(size: number): bigint
read a number of bits from the stream, and return them as a bigint
Parameters
- size: number
Returns bigint
- Defined in packages/io/src/bits/reader.ts:112

readSync

readSync(bytes: number): Uint8Array
Read the specified number of bytes from the source and return them as a Uint8Array.

The returned Uint8Array:
- may be a view into a larger buffer
- is only valid until the next call to readSync
- may be smaller than the requested number of bytes if the end of the source is reached.
these constraints allow for more efficient zero-copy implementations in many cases
Parameters
- bytes: number
  The number of bytes to read
Returns Uint8Array
Uint8Array containing the bytes that were read.
Implementation of ISyncReadable.readSync
- Defined in packages/io/src/bits/reader.ts:31

skipBits

skipBits(size: number): void
skip a number of bits from the stream
Parameters
- size: number
Returns void
- Defined in packages/io/src/bits/reader.ts:163