Struct q_compress::BitWriter

pub struct BitWriter { /* private fields */ }

Builds compressed data, enabling a Compressor to write bit-level information and ultimately output a Vec<u8>.

It does this by maintaining a bit index from 0 to usize::BITS within its most recent usize.

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

Implementations

impl BitWriter

pub fn byte_size(&self) -> usize

Returns the number of bytes so far produced by the writer.

pub fn bit_size(&self) -> usize

Returns the number of bits so far produced by the writer.

pub fn write_aligned_bytes(&mut self, bytes: &[u8]) -> QCompressResult<()>

Appends the bits to the writer. Will return an error if the writer is misaligned.

pub fn write_one(&mut self, b: bool)

Appends the bit to the writer.

pub fn write(&mut self, bs: &[bool])

Appends the bits to the writer.

pub fn bytes(&self) -> Vec<u8>

Returns the bytes produced by the writer.

Trait Implementations

impl Clone for BitWriter

fn clone(&self) -> BitWriter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for BitWriter

fn default() -> Self

Returns the “default value” for a type.