Struct Book 

pub struct Book<K: Ord + Clone> { /* private fields */ }

A codebook used for encoding.

Implementations

impl<K: Ord + Clone> Book<K>

pub fn into_inner(self) -> BTreeMap<K, BitVec>

Returns the underlying B-Tree.

pub fn symbols(&self) -> Keys<'_, K, BitVec>

An iterator over all symbols in sorted order.

pub fn iter(&self) -> Iter<'_, K, BitVec>

An iterator over all symbol and code word pairs, sorted by symbol.

pub fn len(&self) -> usize

Returns the number of symbols in the book.

pub fn is_empty(&self) -> bool

Returns true if the map has no symbols.

pub fn get<Q>(&self, k: &Q) -> Option<&BitVec>

where K: Borrow<Q>, Q: Ord + ?Sized,

Returns the code word for a given symbol.

pub fn contains_symbol<Q>(&self, k: &Q) -> bool

where K: Borrow<Q>, Q: Ord + ?Sized,

Returns true if the book contains the specified symbol.

pub fn encode<Q>(&self, buffer: &mut BitVec, k: &Q) -> Result<(), EncodeError>

where K: Borrow<Q>, Q: Ord + ?Sized,

Writes the code word for the given key to a bit vector.

Errors

Returns EncodeError if k is not in the codebook.

Trait Implementations

impl<K: Clone + Ord + Clone> Clone for Book<K>

fn clone(&self) -> Book<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Ord + Clone> Debug for Book<K>

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

Formats the value using the given formatter.