Struct arpabet_types::Arpabet

pub struct Arpabet { /* fields omitted */ }

A dictionary that contains mappings of words to polyphones.

Implementations

impl Arpabet

pub fn new() -> Arpabet

Create an empty Arpabet.

pub fn from_map(map: HashMap<Word, Polyphone>) -> Self

Create an Arpabet from a map. Consumes the map.

pub fn from_phf_map(map: &Map<&str, &[Phoneme]>) -> Self

Create an Arpabet from a phf::Map. Used internally for allocation from codegen. Unfortunately this needs to allocate a new HashMap and copy data over.

pub fn get_polyphone(&self, word: &str) -> Option<Polyphone>

Get a polyphone from the dictionary.

pub fn get_polyphone_ref(&self, word: &str) -> Option<&Polyphone>

Get a polyphone from the dictionary.

pub fn get_polyphone_str(&self, word: &str) -> Option<Vec<&'static str>>

Get a polyphone from the dictionary.

pub fn combine(&self, other: &Arpabet) -> Arpabet

Combine two Arpabets and return the result. Items in the second Arpabet take precedence.

pub fn merge_from(&mut self, other: &Arpabet)

Merge the supplied Arpabet into the current one. Items in the supplied Arpabet override existing entries should they already exist.

pub fn insert(&mut self, key: Word, value: Vec<Phoneme>) -> Option<Vec<Phoneme>>

Insert an entry into the Arpabet. If the entry is already present, replace it and return the old value.

pub fn remove(&mut self, key: &str) -> Option<Vec<Phoneme>>

Remove an entry from the arpabet. If it is present, it will be returned.

pub fn keys(&self) -> Keys<'_, String, Vec<Phoneme>>

Return a keys iterator that walks the keys in random order.

pub fn len(&self) -> usize

Reports the number of entries in the arpabet.

Trait Implementations

impl Clone for Arpabet

fn clone(&self) -> Arpabet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Arpabet

fn default() -> Arpabet

Returns the "default value" for a type.