Struct binjs_io::entropy::dictionary::DictionaryFamily

pub struct DictionaryFamily<T> { /* fields omitted */ }

A family of dictionaries.

By convention:

• key "" maps to the starting dictionary;
• key "*" maps to the fallback dictionary, in which all probabilities are equal.

Methods

impl<T> DictionaryFamily<T>

pub fn exit(&mut self, name: &SharedString)

Exit the current dictionary, returning to the parent dictionary.

Failure

Fails if name is not the name of the current dictionary. Used for assertion purposes.

pub fn len(&self) -> usize

Return the sum of lengths of all dictionaries in this family.

impl DictionaryFamily<Instances>

pub fn new() -> Self

Create an empty DictionaryFamily.

Initially, this DictionaryFamily does not have a current dictionary. Before the first call to Self::current or Self::current_mut, clients MUST call either enter_existingor enter_or_create to enter a dictionary.

pub fn enter_or_create(&mut self, name: &SharedString, options: Options)

Push a dictionary on top of the stack. Create the dictionary if no such dictionary exists.

pub fn current_mut(&mut self) -> &mut Dictionary<Instances>

Access the current dictionary, mutably.

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut Dictionary<Instances>>

Iterate mutably through all dictionaries in this family.

pub fn insert_baseline(&mut self, dictionary: Dictionary<Instances>) -> bool

Manually insert a dictionary in the family.

Returns true if there was already a baseline dictionary, false otherwise.

impl DictionaryFamily<SymbolInfo>

pub fn enter_existing(&mut self, name: &SharedString) -> Result<(), ()>

pub fn current(&self) -> &Dictionary<SymbolInfo>

Access the current dictionary, immutably.

Trait Implementations

impl<T: Clone> Clone for DictionaryFamily<T>

fn clone(&self) -> DictionaryFamily<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, T> Deserialize<'de> for DictionaryFamily<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl InstancesToProbabilities for DictionaryFamily<Instances>

type AsProbabilities = DictionaryFamily<SymbolInfo>

fn instances_to_probabilities(
    &self,
    description: &str
) -> DictionaryFamily<SymbolInfo>

impl<T> Serialize for DictionaryFamily<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.