Struct BitReader 

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

Reads fields MSB-first from a borrowed byte slice.

Implementations

impl<'a> BitReader<'a>

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

Create a reader positioned at the first bit of data.

pub fn total_bits(&self) -> usize

Total bits in the backing buffer.

pub fn bits_read(&self) -> usize

Bits already consumed.

pub fn bits_remaining(&self) -> usize

Bits not yet consumed.

pub fn is_byte_aligned(&self) -> bool

true if the cursor sits on a byte boundary.

pub fn read_bits(&mut self, n: u32) -> Result<u64, BitError>

Read n bits (0..=64) MSB-first into the low bits of a u64.

read_bits(0) returns 0 and consumes nothing.

Errors

BitError::TooManyBits if n > 64; BitError::OutOfBounds if fewer than n bits remain.

pub fn read_bool(&mut self) -> Result<bool, BitError>

Read a single bit as a bool (1 → true).

Errors

BitError::OutOfBounds if no bits remain.

pub fn skip_bits(&mut self, n: usize) -> Result<(), BitError>

Skip n bits without interpreting them.

Errors

BitError::OutOfBounds if fewer than n bits remain.

pub fn align_to_byte(&mut self)

Advance to the next byte boundary (no-op if already aligned).

Trait Implementations

impl<'a> Clone for BitReader<'a>

fn clone(&self) -> BitReader<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.