Struct Explanation 

pub struct Explanation {
    pub lower_cased: String,
    pub patterns: Vec<MatchedPattern>,
    pub aggregate_scores: Vec<u8>,
}

Explanation of why a word is hyphenated the way it is.

Fields

lower_cased: String

Lower cased word.

patterns: Vec<MatchedPattern>

All patterns that matched the word.

aggregate_scores: Vec<u8>

Aggregate scores among all scores for matching patterns.

Implementations

impl Explanation

pub fn is_interesting(&self) -> bool

Whether this hyphenation explanation is “interesting”

A hyphenation is interesting if there is at least one hyphen and there is at least one position where there are competing patterns (i.e. one pattern says to hyphenate and another says not to).

Trait Implementations

impl Debug for Explanation

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

Formats the value using the given formatter.

impl Display for Explanation

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

Formats the value using the given formatter.

impl PartialEq for Explanation

fn eq(&self, other: &Explanation) -> 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 StructuralPartialEq for Explanation