Struct BitReader 

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

A big-endian, MSB-first bit reader.

Implementations

impl<'a> BitReader<'a>

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

Wraps an RBSP byte slice.

pub fn data(&self) -> &'a [u8]

The underlying RBSP buffer (for handing off to the CABAC engine).

pub fn bit_pos(&self) -> usize

Current bit position.

pub fn bit_len(&self) -> usize

Total number of bits in the buffer.

pub fn bits_left(&self) -> usize

Bits remaining.

pub fn more_rbsp_data(&self) -> bool

more_rbsp_data() (spec §7.2): true while the read position is before the rbsp_stop_one_bit (the last set bit in the buffer). Used to detect the end of slice_data() when a picture is split into multiple slices.

pub fn is_byte_aligned(&self) -> bool

true if the read position sits on a byte boundary.

pub fn align_to_byte(&mut self) -> Result<(), OutOfData>

Advances to the next byte boundary, consuming the intervening bits (e.g. pcm_alignment_zero_bits before an I_PCM payload).

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

Reads a single bit.

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

Reads n bits (n <= 32) as an unsigned value, MSB first. u(n).

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

Peeks the next n bits (n ≤ 24) as an MSB-first value without consuming, zero-filling past the end of the buffer. O(1): loads up to 4 bytes. The zero-fill lets a VLC/Exp-Golomb table match be attempted at the stream end; the caller then skip_bitss the matched length, which rejects (OutOfData) if those bits ran past the buffer.

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

Consumes n bits (advances the position), after a [peek_bits]. Rejects if the bits run past the end of the buffer — the truncated-stream guard that read_bit’s per-bit bounds check provided.

pub fn read_ue(&mut self) -> Result<u32, OutOfData>

Unsigned Exp-Golomb decode, ue(v).

pub fn read_se(&mut self) -> Result<i32, OutOfData>

Signed Exp-Golomb decode, se(v).

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.