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 randomly accesses 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 instantaneous codes, but the casual user should be happy with the default value. See ReadParams for more details.

For additional flexibility, when the std feature is enabled, this structure 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 const fn new(backend: WR) -> Self

Creates a new BitReader with the given word reader.

Trait Implementations

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

const PEEK_BITS: usize = 32

The number of bits that peek_bits is guaranteed to return successfully (with zero-extended EOF).

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, num_bits: usize) -> Result<u64, Self::Error>

Reads num_bits bits and returns 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 Self::PeekWord::BITS.

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

Reads 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>>

Copy bits from self to a BitWrite stream.

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

const PEEK_BITS: usize = 32

The number of bits that peek_bits is guaranteed to return successfully (with zero-extended EOF).

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, num_bits: usize) -> Result<u64, Self::Error>

Reads num_bits bits and returns 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 Self::PeekWord::BITS.

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

Reads 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>>

Copy bits from self to a BitWrite stream.

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

type Error = Infallible

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

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

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

Sets 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 duplicate 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<WR: WordRead<Word = u64> + WordSeek<Error = <WR as WordRead>::Error>> DeltaRead<BigEndian> for BitReader<BigEndian, WR, DefaultReadParams>

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

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

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

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

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

type Flat = False

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

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

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

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

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

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

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, _memdbg_refs: &mut HashSet<usize>, ) -> 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, dbg_refs: &mut HashSet<usize>, ) -> Result<(), Error>

fn _mem_dbg_depth_on_impl( &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, dbg_refs: &mut HashSet<usize>, ref_display: RefDisplay, ) -> Result<(), Error>

Internal implementation for depth display.

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

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

fn mem_size_rec( &self, _memsize_flags: SizeFlags, _memsize_refs: &mut HashMap<usize, usize>, ) -> usize

Recursive implementation that tracks visited references for deduplication.

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

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

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

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

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

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

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

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

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

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

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

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

impl<WR: WordRead<Word = u64> + WordSeek<Error = <WR as WordRead>::Error>, RP: ReadParams> Read for BitReader<BE, WR, RP>

Available on crate feature std only.

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” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl<WR: WordRead<Word = u64> + WordSeek<Error = <WR as WordRead>::Error>, RP: ReadParams> Read for BitReader<LE, WR, RP>

Available on crate feature std only.

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” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

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

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

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

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

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

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