Struct CodeBuilder

pub struct CodeBuilder<K: Ord + Clone, W: Saturating + Ord> { /* private fields */ }

Collects information about symbols and their weights used to construct a Huffman code.

Stability

The constructed code is guaranteed to be deterministic and stable across semver compatible releases if:

• There is a strict order on the symbols K.
• No duplicate symbols are added.

The ordering of symbols will be used to break ties when weights are equal.

Implementations

impl<K: Ord + Clone, W: Saturating + Ord> CodeBuilder<K, W>

pub fn new() -> CodeBuilder<K, W>

Creates a new, empty CodeBuilder<K, W>.

pub fn with_capacity(capacity: usize) -> CodeBuilder<K, W>

Creates a new, empty CodeBuilder<K, W> and preallocates space for capacity symbols.

pub fn push(&mut self, symbol: K, weight: W)

Adds a symbol and weight pair.

pub fn finish(self) -> (Book<K>, Tree<K>)

Constructs a book and tree pair for encoding and decoding.

Trait Implementations

impl<K: Clone + Ord + Clone, W: Clone + Saturating + Ord> Clone for CodeBuilder<K, W>

fn clone(&self) -> CodeBuilder<K, W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Ord + Clone, W: Debug + Saturating + Ord> Debug for CodeBuilder<K, W>

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

Formats the value using the given formatter.

impl<K: Ord + Clone, W: Saturating + Ord> Default for CodeBuilder<K, W>

fn default() -> CodeBuilder<K, W>

Returns the “default value” for a type.

impl<'a, K: Ord + Clone, W: Saturating + Ord + Clone> Extend<(&'a K, &'a W)> for CodeBuilder<K, W>

fn extend<T>(&mut self, weights: T)

where T: IntoIterator<Item = (&'a K, &'a W)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: Ord + Clone, W: Saturating + Ord> Extend<(K, W)> for CodeBuilder<K, W>

fn extend<T>(&mut self, weights: T)

where T: IntoIterator<Item = (K, W)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, K: Ord + Clone, W: Saturating + Ord + Clone> FromIterator<(&'a K, &'a W)> for CodeBuilder<K, W>

fn from_iter<T>(weights: T) -> CodeBuilder<K, W>

where T: IntoIterator<Item = (&'a K, &'a W)>,

Creates a value from an iterator.

impl<K: Ord + Clone, W: Saturating + Ord> FromIterator<(K, W)> for CodeBuilder<K, W>

fn from_iter<T>(weights: T) -> CodeBuilder<K, W>

where T: IntoIterator<Item = (K, W)>,

Creates a value from an iterator.