Struct q_compress::BitReader

pub struct BitReader<'a> { /* private fields */ }

Wrapper around compressed data, enabling a Decompressor to read bit-level information and maintain its position in the data.

It does this with a slice of usizes representing the data and maintaining

• an index into the slice and
• a bit index from 0 to usize::BITS within the current usize.

The reader is consider is considered “aligned” if the current bit index is byte-aligned; e.g. bit_idx % 8 == 0.

Implementations

impl<'a> BitReader<'a>

pub fn aligned_byte_idx(&self) -> QCompressResult<usize>

Returns the reader’s current byte index. Will return an error if the reader is at a misaligned position.

pub fn bits_remaining(&self) -> usize

Returns the number of bits between the reader’s current position and the end.

pub fn byte_size(&self) -> usize

Returns the number of bytes in the reader.

pub fn read_aligned_bytes(&mut self, n: usize) -> QCompressResult<Vec<u8>>

Returns the next n bytes. Will return an error if there are not enough bytes remaining in the reader or the reader is misaligned.

pub fn read_one(&mut self) -> QCompressResult<bool>

Returns the next bit. Will return an error if we have reached the end of the reader.

pub fn read(&mut self, n: usize) -> QCompressResult<Vec<bool>>

Returns the next n bits. Will return an error if there are not enough bits remaining.

pub fn unchecked_read_one(&mut self) -> bool

Returns the next bit. Will panic if we have reached the end of the reader. This tends to be much faster than read_one().

pub fn seek_to(&mut self, bit_idx: usize)

Sets the bit reader’s current position to the specified bit index. Will NOT check whether the resulting position is in bounds or not.

pub fn seek(&mut self, n: usize)

Skips forward n bits. Will NOT check whether the resulting position is in bounds or not.

Wraps seek_to.

pub fn rewind(&mut self, n: usize)

Skips backward n bits. Will panic if the resulting position is out of bounds.

Wraps seek_to.

Trait Implementations

impl<'a> Clone for BitReader<'a>

fn clone(&self) -> BitReader<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> From<&'a BitWords> for BitReader<'a>

fn from(bit_words: &'a BitWords) -> Self

Converts to this type from the input type.