Struct SimpleOccurences

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

Implementations

impl<'a> SimpleOccurences<'a>

Once this is used, call Self::missing and MissingOccurrences::apply to remove the missing entries found during the search.

Panics

Using the OccurenceProvider::occurrences_of_word may panic, if not all documents returned from Provider::documents_with_word. If a document doesn’t exist, still Self::add_document, but with an empty String.

pub fn new(index: &'a Simple, word_proximates: &'a ProximateMap<'a>) -> Self

The proximity::ProximateMap can be acquired from crate::query::Documents::take_proximate_map which is returned from crate::Query::documents.

pub fn add_document(&mut self, id: Id, content: Arc<String>)

pub fn missing(&self) -> MissingOccurrences

Remove the missing references.

Trait Implementations

impl<'a> Debug for SimpleOccurences<'a>

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

Formats the value using the given formatter.

impl<'a> OccurenceProvider<'a> for SimpleOccurences<'a>

type Iter = SimpleOccurrencesIter<'a, Box<dyn Iterator<Item = (Id, &'a Alphanumeral<StrPtr>, f32)> + 'a>>

fn occurrences_of_word(&'a self, word: &'a str) -> Option<Self::Iter>

word_count_limit is the limit where only words starting with the first char of word will be checked for proximity.