pub struct SuggestionEngine { /* private fields */ }Expand description
Main spelling suggestion engine.
Implementations§
Source§impl SuggestionEngine
impl SuggestionEngine
Sourcepub fn new(dictionary: SpellingDictionary) -> Self
pub fn new(dictionary: SpellingDictionary) -> Self
Create a new suggestion engine with the given dictionary.
Sourcepub fn with_config(
dictionary: SpellingDictionary,
config: SuggestionConfig,
) -> Self
pub fn with_config( dictionary: SpellingDictionary, config: SuggestionConfig, ) -> Self
Create a new suggestion engine with custom configuration.
Sourcepub fn set_config(&mut self, config: SuggestionConfig)
pub fn set_config(&mut self, config: SuggestionConfig)
Update the configuration.
Sourcepub fn suggest(&self, word: &str) -> Vec<Suggestion>
pub fn suggest(&self, word: &str) -> Vec<Suggestion>
Get suggestions for a potentially misspelled word.
Sourcepub fn dictionary_stats(&self) -> (usize, u64)
pub fn dictionary_stats(&self) -> (usize, u64)
Get dictionary statistics.
Sourcepub fn is_correct(&self, word: &str) -> bool
pub fn is_correct(&self, word: &str) -> bool
Check if a word exists in the dictionary.
Sourcepub fn add_word(&mut self, word: &str, frequency: u32)
pub fn add_word(&mut self, word: &str, frequency: u32)
Add a word to the dictionary with the given frequency.
This allows the suggestion engine to learn new words dynamically.
Sourcepub fn word_frequency(&self, word: &str) -> u32
pub fn word_frequency(&self, word: &str) -> u32
Get the frequency of a word in the dictionary.
Auto Trait Implementations§
impl Freeze for SuggestionEngine
impl RefUnwindSafe for SuggestionEngine
impl Send for SuggestionEngine
impl Sync for SuggestionEngine
impl Unpin for SuggestionEngine
impl UnsafeUnpin for SuggestionEngine
impl UnwindSafe for SuggestionEngine
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Returns whether the given value has been niched. Read more
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.