Struct dsi_bitstream::utils::CountBitReader

pub struct CountBitReader<E: Endianness, BR: BitRead<E>, const PRINT: bool = false> {
    pub bits_read: usize,
    /* private fields */
}

A wrapper around a BitRead that keeps track of the number of bits read and optionally prints on standard error the operations performed on the stream.

Fields

bits_read: usize

The number of bits read (or skipped) so far from the underlying BitRead.

Implementations

impl<E: Endianness, BR: BitRead<E>, const PRINT: bool> CountBitReader<E, BR, PRINT>

pub fn new(bit_read: BR) -> Self

Trait Implementations

impl<E: Endianness, BR: BitRead<E>, const PRINT: bool> BitRead<E> for CountBitReader<E, BR, PRINT>

type Error = <BR as BitRead<E>>::Error

type PeekWord = <BR as BitRead<E>>::PeekWord

The type we can read from the stream without advancing.

fn read_bits(&mut self, n_bits: usize) -> Result<u64, Self::Error>

Read n bits and return them in the lowest bits.

fn read_unary(&mut self) -> Result<u64, Self::Error>

Read a unary code.

fn peek_bits(&mut self, n_bits: usize) -> Result<Self::PeekWord, Self::Error>

Peeks at n bits without advancing the stream position. n must be nonzero, and at most PeekWord::BITS.

fn skip_bits(&mut self, n_bits: usize) -> Result<(), Self::Error>

Skip n bits from the stream.

fn copy_to<F: Endianness, W: BitWrite<F>>( &mut self, bit_write: &mut W, n: u64 ) -> Result<(), CopyError<Self::Error, W::Error>>

impl<E: Endianness, BR: BitRead<E> + BitSeek, const PRINT: bool> BitSeek for CountBitReader<E, BR, PRINT>

type Error = <BR as BitSeek>::Error

fn bit_pos(&mut self) -> Result<u64, Self::Error>

Get the current position in bits from the start of the stream.

fn set_bit_pos(&mut self, bit_pos: u64) -> Result<(), Self::Error>

Set the current position in bits from the start of the stream to bit_pos.

impl<E: Clone + Endianness, BR: Clone + BitRead<E>, const PRINT: bool> Clone for CountBitReader<E, BR, PRINT>

fn clone(&self) -> CountBitReader<E, BR, PRINT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Endianness, BR: Debug + BitRead<E>, const PRINT: bool> Debug for CountBitReader<E, BR, PRINT>

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

Formats the value using the given formatter.

impl<E: Endianness, BR: BitRead<E> + DeltaRead<E>, const PRINT: bool> DeltaRead<E> for CountBitReader<E, BR, PRINT>

fn read_delta(&mut self) -> Result<u64, BR::Error>

impl<E: Endianness, BR: BitRead<E> + GammaRead<E>, const PRINT: bool> GammaRead<E> for CountBitReader<E, BR, PRINT>

fn read_gamma(&mut self) -> Result<u64, BR::Error>

impl<E: Endianness, BR: BitRead<E> + ZetaRead<E>, const PRINT: bool> ZetaRead<E> for CountBitReader<E, BR, PRINT>

fn read_zeta(&mut self, k: u64) -> Result<u64, BR::Error>

fn read_zeta3(&mut self) -> Result<u64, BR::Error>