Module indicium::simple

source ·
Expand description

The simple Indicium search implementation. Fewer bells-and-whistles but easier to use than the other options.

There might be more search implementations in future versions.

Structs§

  • The search index. This is the most important structure in Indicium simple search. You may instantiate your search index with SearchIndex::default() or use the SearchIndexBuilder builder pattern.
  • The builder pattern can be used to customize your search index. Use SearchIndexBuilder::default() to start the builder chain, and .build() to finish it.

Enums§

  • Indicium simple search provides three types of autocomplete. The best autocompletion type that should be used depends on the user interface and the data-set. See variant descriptions for more information.
  • This is used to select a string similarity metric implemented by Ilia Schelokov’s eddie crate.
  • Indicium simple search provides four types of search. The best search type that should be used really depends on your use-case: the nature of the data, the intent of the user, and the size of your data set.
  • This is used to select a string similarity metric implemented by Danny Guo’s strsim crate.

Traits§

  • To make a record indexable for Indicium Search, the Indexable trait must be implemented for it. The trait returns a Vec<String> of all content that is to be indexed.