Struct Span

pub struct Span {
    pub start: usize,
    pub end: usize,
    pub element: ParsedElement,
}

Shows a region of the cleaned transcript which an SSML element applies to.

Fields

start: usize

This is the index of span’s start (inclusive) in terms of unicode scalar values - not bytes or graphemes

end: usize

This is the of span’s end (exclusive) in terms of unicode scalar values - not bytes or graphemes

element: ParsedElement

The element contained within this span

Implementations

impl Span

pub fn maybe_contains(&self, other: &Self) -> bool

Returns true if a span is contained within another span. This only takes advantage of the start and end indexes. Other constraints such as the fact the parser returns spans in order they’re seen need to be used in combination to see if this really contains the other span. So if you’re going over the list in order you can rely on this but if you’ve rearranged the tag list it may not hold true.

This does handle tags which can’t contain other tags. So <break/><break/> will appear with the same start and end. However break has to be an empty tag. This function will return false. Whereas <s/><s/> will return true as a sentence can contain other tags. In future as a sentence cannot contain a sentence this may return false.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl Ord for Span

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Span

fn eq(&self, other: &Span) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Span

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Span

impl StructuralPartialEq for Span