Trait Provider

pub trait Provider<'a> {
    type DocumentIter: Iterator<Item = Id> + ExactSizeIterator + 'a;
    type WordIter: Iterator<Item = &'a Arc<Alphanumeral<StrPtr>>> + 'a;
    type WordFilteredIter: Iterator<Item = &'a Arc<Alphanumeral<StrPtr>>> + 'a;

    // Required methods
    fn insert_word(&mut self, word: impl AsRef<str>, document: Id, index: usize);
    fn remove_document(&mut self, document: Id);
    fn contains_word(&self, word: impl AsRef<str>, document: Id) -> bool;
    fn documents_with_word(
        &'a self,
        word: impl AsRef<str>,
    ) -> Option<Self::DocumentIter>;
    fn size(&self) -> usize;
    fn word_count_upper_limit(&self) -> usize;
    fn word_count_limit(&self) -> usize;
    fn words(&'a self) -> Self::WordIter;
    fn words_starting_with(&'a self, c: char) -> Self::WordFilteredIter;
    fn word_proximity_threshold(&self) -> f32;
    fn word_proximity_algorithm(&self) -> Algorithm;

    // Provided method
    fn digest_document(&mut self, id: Id, content: &str) { ... }
}

Allows to insert words and remove occurrences from documents.

Required Associated Types

type DocumentIter: Iterator<Item = Id> + ExactSizeIterator + 'a

type WordIter: Iterator<Item = &'a Arc<Alphanumeral<StrPtr>>> + 'a

type WordFilteredIter: Iterator<Item = &'a Arc<Alphanumeral<StrPtr>>> + 'a

Required Methods

fn insert_word(&mut self, word: impl AsRef<str>, document: Id, index: usize)

The implementation should convert word to lower-case and remove any hyphen -.

Alphanumeral can be used for this purpose.

fn remove_document(&mut self, document: Id)

Removes all registered occurrences of document from all words.

fn contains_word(&self, word: impl AsRef<str>, document: Id) -> bool

If document contains at least one occurrence of word.

fn documents_with_word( &'a self, word: impl AsRef<str>, ) -> Option<Self::DocumentIter>

fn size(&self) -> usize

Estimate of the number of bytes this index uses in memory, specifically the heap.

This assumes you’re on a 64-bit architecture. Else, you can expect the size to be half, as most of what’s stored in an index is pointers to data.

This should not be relied on. Rather, it’s a hint.

fn word_count_upper_limit(&self) -> usize

fn word_count_limit(&self) -> usize

The limit of Self::word_count_upper_limit where Self::words_starting_with is used instead of Self::words.

fn words(&'a self) -> Self::WordIter

fn words_starting_with(&'a self, c: char) -> Self::WordFilteredIter

fn word_proximity_threshold(&self) -> f32

fn word_proximity_algorithm(&self) -> Algorithm

Provided Methods

fn digest_document(&mut self, id: Id, content: &str)

Only adds words which are alphanumeric.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<'a> Provider<'a> for Lossless

type DocumentIter = Copied<Keys<'a, Id, LosslessDocOccurrences>>

type WordIter = Keys<'a, Arc<Alphanumeral<StrPtr>>, LosslessDocMap>

type WordFilteredIter = Map<Range<'a, Arc<Alphanumeral<StrPtr>>, LosslessDocMap>, fn(_: (&'a Arc<Alphanumeral<StrPtr>>, &'a LosslessDocMap)) -> &'a Arc<Alphanumeral<StrPtr>>>

impl<'a> Provider<'a> for Simple

type DocumentIter = Copied<Iter<'a, Id>>

type WordIter = Keys<'a, Arc<Alphanumeral<StrPtr>>, SimpleDocMap>

type WordFilteredIter = Map<Range<'a, Arc<Alphanumeral<StrPtr>>, SimpleDocMap>, fn(_: (&'a Arc<Alphanumeral<StrPtr>>, &'a SimpleDocMap)) -> &'a Arc<Alphanumeral<StrPtr>>>