Struct 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.

For additional flexibility, this structures implements std::io::Read. Note that because of coherence rules it is not possible to implement std::io::Read for a generic BitRead.

Implementations

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

pub fn new(data: WR) -> Self

Trait Implementations

impl<E: Error + Send + Sync + 'static, 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(&mut self) -> Result<u64, Self::Error>

Read a unary code.

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

impl<E: Error + Send + Sync + 'static, 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(&mut self) -> Result<u64, Self::Error>

Read a unary code.

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

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

type Error = Infallible

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_index: u64) -> Result<(), Self::Error>

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

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

type Error = Infallible

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_index: u64) -> Result<(), Self::Error>

Set the current position in bits from the start of the stream 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: Endianness, WR, RP: ReadParams> CopyType for BitReader<E, WR, RP>

where WR: MemSize, u64: MemSize, PhantomData<(E, RP)>: MemSize,

type Copy = False

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 + Send + Sync + 'static, 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>

impl<E: Error + Send + Sync + 'static, 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>

impl<E: Error + Send + Sync + 'static, 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>

impl<E: Error + Send + Sync + 'static, 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>

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

where WR: MemDbgImpl, u64: MemDbgImpl, PhantomData<(E, RP)>: MemDbgImpl,

fn _mem_dbg_rec_on( &self, _memdbg_writer: &mut impl Write, _memdbg_total_size: usize, _memdbg_max_depth: usize, _memdbg_prefix: &mut String, _memdbg_is_last: bool, _memdbg_flags: DbgFlags, ) -> Result

fn _mem_dbg_depth_on( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, ) -> Result<(), Error>

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

where WR: MemSize, u64: MemSize, PhantomData<(E, RP)>: MemSize,

fn mem_size(&self, _memsize_flags: SizeFlags) -> usize

Returns the (recursively computed) overall memory size of the structure in bytes.

impl<E: Error + Send + Sync + 'static, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>, RP: ReadParams> Read for BitReader<BE, WR, RP>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<E: Error + Send + Sync + 'static, WR: WordRead<Error = E, Word = u64> + WordSeek<Error = E>, RP: ReadParams> Read for BitReader<LE, WR, RP>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<E: Error + Send + Sync + 'static, 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: usize) -> Result<u64, Self::Error>

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

impl<E: Error + Send + Sync + 'static, 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: usize) -> Result<u64, Self::Error>

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