Struct BitReader

pub(crate) struct BitReader<R> {
    reader: R,
    buffer: u64,
    nbits: u8,
}

Fields

reader: R

buffer: u64

nbits: u8

Implementations

impl<R: BufRead> BitReader<R>

const fn new(reader: R) -> Self

pub(crate) fn fill(&mut self) -> Result<(), DecodingError>

Fills the buffer with bits from the input stream.

After this function, the internal buffer will contain 64-bits or have reached the end of the input stream.

pub(crate) const fn peek(&self, num: u8) -> u64

Peeks at the next num bits in the buffer.

pub(crate) const fn peek_full(&self) -> u64

Peeks at the full buffer.

pub(crate) fn consume(&mut self, num: u8) -> Result<(), DecodingError>

Consumes num bits from the buffer returning an error if there are not enough bits.

pub(crate) fn read_bits<T: TryFrom<u32>>( &mut self, num: u8, ) -> Result<T, DecodingError>

Convenience function to read a number of bits and convert them to a type.

Trait Implementations

impl<R: Clone> Clone for BitReader<R>

fn clone(&self) -> BitReader<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for BitReader<R>

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

Formats the value using the given formatter.