Struct BitReader 

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

MSB-first bit reader over a borrowed byte slice.

Copy+Clone: the reader owns no heap state, only a borrowed slice and a handful of counters, so let saved = br; followed by a later br = saved; is a valid checkpoint/restore — some codec parsers (e.g. MPEG-4 Part 2’s VOP resync) use exactly that pattern.

Implementations

impl<'a> BitReader<'a>

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

pub fn with_position(data: &'a [u8], byte_pos: usize) -> Self

Start reading at a specific byte offset (useful for parsers that need to re-anchor into the middle of a buffer without copying).

pub fn bit_position(&self) -> u64

Bits already consumed from the logical stream.

pub fn byte_position(&self) -> usize

Byte offset of the reader (floor of bit_position / 8).

pub fn bits_remaining(&self) -> u64

Total remaining bits (buffered + unread from the slice).

pub fn is_byte_aligned(&self) -> bool

True if the reader is positioned on a byte boundary.

pub fn align_to_byte(&mut self)

Skip remaining bits in the current byte, leaving the reader byte-aligned.

pub fn read_u32(&mut self, n: u32) -> Result<u32>

Read n bits (0..=32) as an unsigned integer.

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

Read n bits (0..=64) as an unsigned integer.

pub fn read_i32(&mut self, n: u32) -> Result<i32>

Read n bits as a signed integer, sign-extended from the high bit.

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

Read a single bit as a bool.

pub fn read_u1(&mut self) -> Result<u32>

Read a single bit as 0 or 1 (some codec specs phrase flags this way).

pub fn peek_u32(&mut self, n: u32) -> Result<u32>

Peek n bits (0..=32) without consuming them.

pub fn skip(&mut self, n: u32) -> Result<()>

Discard n bits.

pub fn consume(&mut self, n: u32) -> Result<()>

Alias for Self::skip — some spec wordings prefer “consume”.

pub fn read_unary(&mut self) -> Result<u32>

Read a unary-coded value: the count of leading zero bits, terminated by a single 1. Used by FLAC Rice residuals and any other codec that needs variable-length counts. Uses leading_zeros() on the 64-bit accumulator for the fast path.

pub fn read_bytes(&mut self, n: usize) -> Result<Vec<u8>>

Read n bytes. Requires the reader to be byte-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> Copy for BitReader<'a>