Struct BitPumpMsbWords 

pub struct BitPumpMsbWords<'a, const W: usize> { /* private fields */ }

MSB-first bit order inside little-endian words of W bytes (2 or 4).

Implementations

impl<'a, const W: usize> BitPumpMsbWords<'a, W>

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

Create a pump over data.

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

Remaining unread input (from the byte position of the refill cursor).

pub fn buffered_bits(&self) -> u32

Bits currently buffered.

pub fn bit_position(&self) -> u64

Bits consumed from the start of the input (padding past the end included).

pub fn at_bit(data: &'a [u8], bit: u64) -> Self

A pump positioned bit bits into data (word-aligned start, then skipped).

Trait Implementations

impl<const W: usize> BitRead for BitPumpMsbWords<'_, W>

fn fill(&mut self)

Ensure at least 32 bits are buffered (zero-padded past the end of input).

fn refill_force(&mut self)

Refill to the pump’s maximum fill level even if 32 or more bits are buffered.

fn peek_no_fill(&self, n: u32) -> u32

Peek n <= 32 bits. Requires a prior BitRead::fill.

fn skip_no_fill(&mut self, n: u32)

Discard n <= 32 bits. Requires that n bits are buffered.

fn byte_position(&self) -> usize

Number of bytes consumed from the input (bits not yet used are excluded).

fn overrun(&self) -> usize

Bytes requested past the end of the input (0 for a well-formed stream). Includes look-ahead that has not been consumed; see BitRead::past_end.

fn buffered(&self) -> u32

Bits currently buffered (not yet consumed).

fn past_end(&self) -> usize

Bytes consumed beyond the end of the input (padding fed but still buffered is not counted). Decoders use this to detect truncated streams precisely.

fn fill_to(&mut self, n: u32)

Ensure at least n bits (n <= 56) are buffered (zero padding past the end).

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

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

fn skip(&mut self, n: u32)

fn bit(&mut self) -> u32

Read a single bit.

fn exhausted(&self) -> bool

True if the stream ran (meaningfully) past the end of its data.

impl<'a, const W: usize> Clone for BitPumpMsbWords<'a, W>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.