Struct Suggester 

pub struct Suggester<'a, S: BuildHasher> { /* private fields */ }

A wrapper struct for a dictionary that allows customizing suggestion behavior.

Currently only ngram suggestions may be configured.

Implementations

impl<'a, S: BuildHasher> Suggester<'a, S>

pub fn into_checker(self) -> Checker<'a, S>

Returns the underlying Checker used by this suggester.

pub fn with_ngram_suggestions(self, ngram_suggest: bool) -> Self

Enables or disables the suggester from finding suggestions based on “ngram similarity.”

Ngram similarity is a bespoke string similarity metric used by the suggester to find suggestions when string edits don’t produce any likely candidates. Finding a suggestion with ngram similarity involves iterating through the dictionary’s wordlist and therefore ngram suggestion can be very slow depending on the dictionary size.

Ngram suggestion is enabled by default.

pub fn suggest(&self, word: &str, out: &mut Vec<String>)

Fills the given vec with possible corrections from the dictionary for the given word.

Trait Implementations

impl<'a, S: Clone + BuildHasher> Clone for Suggester<'a, S>

fn clone(&self) -> Suggester<'a, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: BuildHasher> Debug for Suggester<'_, S>

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

Formats the value using the given formatter.

impl<'a, S: Copy + BuildHasher> Copy for Suggester<'a, S>