Struct dsi_bitstream::impls::BitReader

pub struct BitReader<E: Endianness, WR, RP: ReadParams = DefaultReadParams> { /* private fields */ }

An implementation of BitRead for a WordRead with word u64 and of BitSeek for a WordSeek.

This implementation accesses randomly the underlying WordRead without any buffering. It is usually slower than BufBitReader.

The peek word is u32. The value returned by peek_bits contains at least 32 bits (extended with zeros beyond end of stream), that is, a full peek word.

The additional type parameter RP is used to select the parameters for the instantanous codes, but the casual user should be happy with the default value. See ReadParams for more details.

Implementations

impl<E: Endianness, WR, RP: ReadParams> BitReader<E, WR, RP>

pub fn new(data: WR) -> Self

Trait Implementations

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>, RP: ReadParams> BitRead<BigEndian> for BitReader<BE, WR, RP>

type Error = <WR as WordRead>::Error

type PeekWord = u32

The type we can read from the stream without advancing.

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

Skip n bits from the stream.

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

Read n bits and return them in the lowest bits.

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

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

fn read_unary_param<const USE_TABLE: bool>( &mut self ) -> Result<u64, Self::Error>

Read a unary code.

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

Read a unary code.

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

Skip a unary code.

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>, RP: ReadParams> BitRead<LittleEndian> for BitReader<LE, WR, RP>

type Error = <WR as WordRead>::Error

type PeekWord = u32

The type we can read from the stream without advancing.

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

Skip n bits from the stream.

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

Read n bits and return them in the lowest bits.

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

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

fn read_unary_param<const USE_TABLE: bool>( &mut self ) -> Result<u64, Self::Error>

Read a unary code.

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

Read a unary code.

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

Skip a unary code.

impl<WR: WordSeek, RP: ReadParams> BitSeek for BitReader<BE, WR, RP>

type Error = Infallible

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

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

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

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

impl<WR: WordSeek, RP: ReadParams> BitSeek for BitReader<LE, WR, RP>

type Error = Infallible

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

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

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

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

impl<E: Clone + Endianness, WR: Clone, RP: Clone + ReadParams> Clone for BitReader<E, WR, RP>

fn clone(&self) -> BitReader<E, WR, RP>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Endianness, WR: Debug, RP: Debug + ReadParams> Debug for BitReader<E, WR, RP>

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

Formats the value using the given formatter.

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>> DeltaRead<BigEndian> for BitReader<BigEndian, WR, DefaultReadParams>

where WR::Word: DoubleType + UpcastableInto<u64>, <WR::Word as DoubleType>::DoubleType: CastableInto<u64>,

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

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

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>> DeltaRead<LittleEndian> for BitReader<LittleEndian, WR, DefaultReadParams>

where WR::Word: DoubleType + UpcastableInto<u64>, <WR::Word as DoubleType>::DoubleType: CastableInto<u64>,

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

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

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>> GammaRead<BigEndian> for BitReader<BigEndian, WR, DefaultReadParams>

where WR::Word: DoubleType + UpcastableInto<u64>, <WR::Word as DoubleType>::DoubleType: CastableInto<u64>,

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

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

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>> GammaRead<LittleEndian> for BitReader<LittleEndian, WR, DefaultReadParams>

where WR::Word: DoubleType + UpcastableInto<u64>, <WR::Word as DoubleType>::DoubleType: CastableInto<u64>,

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

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

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>> ZetaRead<BigEndian> for BitReader<BigEndian, WR, DefaultReadParams>

where WR::Word: DoubleType + UpcastableInto<u64>, <WR::Word as DoubleType>::DoubleType: CastableInto<u64>,

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

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

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

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

impl<E: Error, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>> ZetaRead<LittleEndian> for BitReader<LittleEndian, WR, DefaultReadParams>

where WR::Word: DoubleType + UpcastableInto<u64>, <WR::Word as DoubleType>::DoubleType: CastableInto<u64>,

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

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

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

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