Struct LangProvider

pub struct LangProvider<'a> { /* private fields */ }

A structure to ensure that the data files for the given language are available.

It can look for files on the disk or download directly from internet when possible.

Implementations

impl LangProvider<'_>

pub fn new<'a>(lang: &'a str, config: &'a Config) -> LangProvider<'a>

Creates a new LanguageProvider for the given language and configuration.

The configuration can be loaded using load_config().

pub fn aff(&self) -> &Path

Location of the .aff dictionary.

pub fn aff_on_disk(&self) -> Vec<PathBuf>

Search for corresponding .aff dictionaries on the disk.

pub fn dic(&self) -> &Path

Location of the .dic dictionary.

pub fn dic_on_disk(&self) -> Vec<PathBuf>

Search for corresponding .dic dictionaries on the disk.

pub fn ensure_data(&self) -> Result<(), SpellError>

Ensures that the dictionaries are present in the dictionaries directory.

If one of the dictionaries is absent it will be fetched from the disk or directly from internet when possible.

pub fn remove_data(&self) -> Result<(), SpellError>

Removes the dictionaries from the dictionaries directory.

Trait Implementations

impl Into<Hunspell> for LangProvider<'_>

fn into(self) -> Hunspell

Converts this type into the (usually inferred) input type.