Struct Ssml

pub struct Ssml { /* private fields */ }

Holds parsed SSML string with the text minus tags and the tag information

Implementations

impl Ssml

pub fn get_text(&self) -> &str

Gets a version of the text with all the SSML tags stripped

pub fn get_text_from_span(&self, span: &Span) -> &str

From a given span with start/end characters return the text within that span.

Panics

Will panic if span exceeds the bounds of the text.

pub fn tags(&self) -> impl Iterator<Item = &Span>

Get an iterator over the SSML tags - traversed depth first.

pub fn write_ssml(&self) -> String

Write out the SSML text again - mainly used for testing correctness of implementation.

pub fn write_ssml_with_transform<F>(&self, f: F) -> TransformedSsml

where F: FnMut(ParserEvent) -> Option<ParserEvent>,

For each parser event to write out apply a transformation to it or return None if it should be filtered out. It is up to the implementor to make sure that if an open tag is removed the corresponding close tag is removed as well.

TODO this doesn’t track if there are tags where inner text shouldn’t be synthesised so certain transformations will lead to synthesisable_text being incorrect.

pub fn event_iter(&self) -> impl Iterator<Item = ParserEvent> + '_

Turns the SSML document into a stream of events with open/close tags, text and empty elements. This will not filter out text that shouldn’t be synthesised so it’s on the user to keep track of this.

Trait Implementations

impl Clone for Ssml

fn clone(&self) -> Ssml

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ssml

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

Formats the value using the given formatter.