Struct zng_ext_font::HYPHENATION

pub struct HYPHENATION;

Hyphenation service.

Note that dictionary data is required to support a language, if the feature "hyphenation_embed_all" is enabled dictionaries for all supported languages is embedded, otherwise dictionaries must be loaded using a HyphenationDataSource.

You can use the HyphenationDataDir to use external files, see the hyphenation for more details about the data files.

Implementations

impl HYPHENATION

pub fn init_data_source(&self, source: impl HyphenationDataSource)

Set the hyphenation dictionaries source and clear cache.

Note that this applies immediately and does not notify, it should only be called once during app init.

pub fn hyphenate(&self, lang: &Lang, word: &str) -> Vec<usize>

Try to hyphenate the word using the lang dictionary and rules.

Returns a vector of indexes that allow a line break.

pub fn hyphenate_opt(&self, lang: &Lang, word: &str) -> Option<Vec<usize>>

Try to hyphenate the word using the lang dictionary and rules.

Returns a vector of indexes that allow a line break. Returns None if the lang is not supported or the word contains non-word characters.

pub fn lang_to_hyphenation_language(&self, lang: &Lang) -> Option<Language>

Get the best hyphenation::Language for the lang.

pub fn hyphenate_opt_language( &self, word: &str, lang: Language, ) -> Option<Vec<usize>>

Hyphenate with language already resolved.