Module index

The index (lookup table of words) lives here. The trait Provider (and OccurenceProvider) enables multiple types of indices to be defined.

The only one (for now) is Simple. That stores a list of all the documents which contains each word in the input data (e.g. web pages). It then fetches those documents again and finds occurrences within those.

---

The DocumentMap makes it performant to get the document ID from name and vice versa.

Structs

• Alphanumeral
  Wrapper for representing T as only containing alphanumeric characters.
• AssociatedOccurrence
  If Occurence is part of an AND, these can be associated to tell where the other parts of the AND chain are.
• DocumentMap
  Map of documents and their Ids to quickly get name from id and vice versa.
• Id
  Id of a document.
• Lossless
  Index which keeps track of all occurrences of all words.
• LosslessDocMap
  The docs this word exists in. Each doc has an associated LosslessDocOccurrences which keeps track of all the occurrences in that document.
• LosslessDocOccurrences
  The occurrences of a word in this document.
• LosslessOccurrences
  Get occurrences of a word (or similar words) from this Lossless index.
• LosslessOccurrencesIter
• MissingOccurrences
  A list of missing occurrences collected when searching for occurrences using SimpleOccurences.
• Occurence
  An occurrence of crate::Query.
• Simple
• SimpleDocMap
• SimpleOccurences
• SimpleOccurrencesIter
• StrPtr
  Needed to index a custom struct in maps. We have to have the same type, so this acts as both the borrowed and owned. TODO: Cow? But lifetime is a nightmare?
• WordOccurrence
  Eq isn’t implemented as you’d probably want to check which document it belongs to as well.

Traits

• OccurenceProvider
• Provider
  Allows to insert words and remove occurrences from documents.

Functions

• next_char
  Returns the next valid UTF-8 character.