Struct State

pub struct State<'a, B, W>
where
    B: BitStore,
    W: BitWrite,
{ /* private fields */ }

A convenience struct which stores the internal state of an Encoder.

Implementations

impl<'a, B, W> State<'a, B, W>

where B: BitStore, W: BitWrite,

pub fn new(precision: u32, output: &'a mut W) -> Self

Manually construct a State.

Normally this would be done automatically using the Encoder::new method.

pub fn flush(&mut self) -> Result<()>

Flush the internal buffer and write all remaining bits to the output. This method MUST be called when you finish writing symbols to ensure they are fully written to the output.

Errors

This method can fail if the output cannot be written to

Trait Implementations

impl<'a, B, W> Debug for State<'a, B, W>

where B: BitStore + Debug, W: BitWrite + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.