Struct BitReader 

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

MSB-first bit reader over a borrowed byte slice.

Implementations

impl<'a> BitReader<'a>

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

Create a fresh reader positioned at bit 0 of bytes.

pub fn total_bits(&self) -> usize

Total number of payload bits in the reader.

pub fn bit_pos(&self) -> usize

Current absolute bit offset.

pub fn bits_remaining(&self) -> usize

Number of unread bits (saturating at zero).

pub fn at_end(&self) -> bool

True if the next read would fall past the end of the buffer.

pub fn byte_aligned(&self) -> bool

True if the reader is currently byte-aligned.

pub fn skip(&mut self, n: usize)

Skip forward by n bits.

pub fn align_to_byte(&mut self)

Skip forward to the next byte boundary if not already aligned.

pub fn read_bit(&mut self) -> u32

Read one bit. Returns 0 past the end.

pub fn u(&mut self, n: u32) -> u32

Read n bits MSB first into a u32. Past-the-end bits are 0. n must be ≤ 32 (the upper limit covers every fixed-width field used by H.264 / HEVC / AV1 OBU headers).

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

Read n bits MSB first into a u64 (for AV1’s 64-bit reference_frame_id-class fields).

pub fn ue(&mut self) -> Result<u32, BitstreamError>

Unsigned Exp-Golomb (ue(v)). H.264 9.1 / H.265 9.2. Returns an error if more than 32 leading zeros are seen (would overflow a u32).

pub fn se(&mut self) -> Result<i32, BitstreamError>

Signed Exp-Golomb (se(v)). H.264 9.1.1 / H.265 9.2.2.