Struct libmathcat::speech::SpeechRulesWithContext

pub struct SpeechRulesWithContext<'c, 's: 'c, 'm: 'c> {
    pub inside_spell: bool,
    /* private fields */
}

SpeechRulesWithContext encapsulates a named group of speech rules (e.g, “ClearSpeak”) along with the preferences to be used for speech. Because speech rules can define variables, there is also a context that is carried with them

Fields

inside_spell: bool

Implementations

impl<'c, 's: 'c, 'r, 'm: 'c> SpeechRulesWithContext<'c, 's, 'm>

We track three different lifetimes: ’c – the lifetime of the context and mathml ’s – the lifetime of the speech rules (which is static) ’r – the lifetime of the reference (this seems to be key to keep the rust memory checker happy)

pub fn new(
    speech_rules: &'s SpeechRules,
    doc: Document<'m>,
    nav_node_id: String
) -> SpeechRulesWithContext<'c, 's, 'm>

pub fn get_rules(&mut self) -> &SpeechRules

pub fn get_context(&mut self) -> &mut Context<'c>

pub fn get_document(&mut self) -> Document<'m>

pub fn match_pattern<T: TreeOrString<'c, 'm, T>>(
    &'r mut self,
    mathml: Element<'c>
) -> Result<T>

pub fn replace_chars(
    &'r mut self,
    str: &str,
    mathml: Element<'c>
) -> Result<String>

Lookup unicode “pronunciation” of char. Note: TTS is not supported here (not needed and a little less efficient)

Trait Implementations

impl<'c, 's: 'c, 'm: 'c> Display for SpeechRulesWithContext<'c, 's, 'm>

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

Formats the value using the given formatter.