Struct pyphen_rs::Builder

pub struct Builder<T> { /* fields omitted */ }

Builder struct to create a hyphenation instance

Methods

impl Builder<Rc<String>>

pub fn lang(lang: &str) -> Self

Constructs a new Builder for a given language

• lang - lang of the included dict to use if no filename is given

impl<T> Builder<T>

pub fn filename(filename: T) -> Self

Constructs a new Builder for a given dictionary file

• filename - filename of hyph_*.dic to read

pub fn left(&mut self, left: usize) -> &mut Self

Sets the minimum number of characters in the first syllable

pub fn right(&mut self, right: usize) -> &mut Self

Sets the minimum number of characters in the last syllable

pub fn cache(&mut self, cache: bool) -> &mut Self

Sets whether to use a cached copy of the hyphenation patterns

impl<T> Builder<T> where
    T: Deref<Target = String>, 

pub fn build(&self) -> Result<Pyphen, ()>

Create an hyphenation instance for given lang or filename.

Returns Err if the given lang or filename does not exist.