Struct HyphenationDict 

pub struct HyphenationDict {
    pub language: String,
    pub left_min: usize,
    pub right_min: usize,
    /* private fields */
}

A hyphenation dictionary for a specific language.

Contains compiled patterns in a trie and an exception list for words whose hyphenation deviates from the pattern rules.

Fields

language: String

ISO 639-1 language code (e.g. “en”, “de”).

left_min: usize

Minimum prefix before first break.

right_min: usize

Minimum suffix after last break.

Implementations

impl HyphenationDict

pub fn new(language: &str, patterns: &[&str], exceptions: &[&str]) -> Self

Create a dictionary from raw TeX-format pattern strings and exception words.

Patterns use TeX notation (e.g. "hy3p", ".ex5am"). Exceptions use hyphen-delimited words (e.g. "hy-phen-ation").

pub fn with_margins(self, left: usize, right: usize) -> Self

Set custom left/right minimum margins.

pub fn hyphenate(&self, word: &str) -> Vec<HyphenBreakPoint>

Find all valid hyphenation points in a word.

Returns break points sorted by offset. The word should be a single whitespace-free token (not a phrase or sentence).

pub fn can_hyphenate(&self, word: &str) -> bool

Check if a word has any valid hyphenation points.

Trait Implementations

impl Clone for HyphenationDict

fn clone(&self) -> HyphenationDict

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyphenationDict

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

Formats the value using the given formatter.