Struct BitReader 

pub struct BitReader<'a> { /* private fields */ }

A bit-level reader for decoding packed binary data.

All read operations are bounds-checked and return errors on failure. The reader never panics on malformed input.

Implementations

impl<'a> BitReader<'a>

pub const fn new(data: &'a [u8]) -> Self

Creates a new BitReader from a byte slice.

pub const fn bits_remaining(&self) -> usize

Returns the number of bits remaining to read.

pub const fn is_empty(&self) -> bool

Returns true if there are no more bits to read.

pub const fn bit_position(&self) -> usize

Returns the current bit position.

pub fn read_bit(&mut self) -> BitResult<bool>

Reads a single bit as a boolean.

pub fn read_bits(&mut self, bits: u8) -> BitResult<u64>

Reads up to 64 bits as an unsigned integer.

pub fn align_to_byte(&mut self) -> BitResult<()>

Aligns to the next byte boundary.

pub fn read_u8_aligned(&mut self) -> BitResult<u8>

Reads a byte-aligned u8.

pub fn read_u16_aligned(&mut self) -> BitResult<u16>

Reads a byte-aligned u16 (little-endian).

pub fn read_u32_aligned(&mut self) -> BitResult<u32>

Reads a byte-aligned u32 (little-endian).

pub fn read_u64_aligned(&mut self) -> BitResult<u64>

Reads a byte-aligned u64 (little-endian).

pub fn read_varu32(&mut self) -> BitResult<u32>

Reads a byte-aligned varint u32.

pub fn read_vars32(&mut self) -> BitResult<i32>

Reads a byte-aligned zigzag varint i32.

Trait Implementations

impl<'a> Debug for BitReader<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.