Struct q_compress::BitWriter

pub struct BitWriter { /* private fields */ }

BitWriter builds a Vec<u8>, enabling a compressor to write bit-level information and maintain its position in the bytes.

It does this by maintaining

• a byte index and
• a bit index from 0-8 within that byte.

The reader is consider is considered “aligned” if the current bit index is 0 or 8 (i.e. at the start or end of the current byte).

Implementations

impl BitWriter

pub fn byte_size(&self) -> usize

Returns the number of bytes 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 pop(self) -> Vec<u8>

Returns the bytes produced by the writer, taking ownership and ending the writer’s lifetime.

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.