indicium 0.6.9

Simple in-memory search for collections and key-value stores.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! Contains interfaces to several string similarity and string distance crates.
//! These crates are used for autocompletion and fuzzy-matching user input.

// -----------------------------------------------------------------------------

#[cfg(feature = "eddie")]
mod eddie;

#[cfg(feature = "eddie")]
pub use crate::simple::internal::fuzzers::eddie::fuzzy::Eddie;

#[cfg(feature = "rapidfuzz")]
mod rapidfuzz;

#[cfg(feature = "rapidfuzz")]
pub use crate::simple::internal::fuzzers::rapidfuzz::fuzzy::Rapidfuzz;

#[cfg(feature = "strsim")]
mod strsim;

#[cfg(feature = "strsim")]
pub use crate::simple::internal::fuzzers::strsim::fuzzy::Strsim;

// -----------------------------------------------------------------------------
//
// Enumerations used for selecting the desired string similarity metric in the
// search index settings.

pub mod eddie_metric;
pub mod rapidfuzz_metric;
pub mod strsim_metric;

pub use crate::simple::internal::fuzzers::{
    rapidfuzz_metric::RapidfuzzMetric,
    eddie_metric::EddieMetric,
    strsim_metric::StrsimMetric
};

// -----------------------------------------------------------------------------
//
/// The `Fuzzy` trait allows `indicium` to treat the various string similarity
/// crates (such as `eddie`, `rapidfuzz`, `strsim`, etc.) generically.

#[cfg(any(feature = "strsim", feature = "eddie", feature = "rapidfuzz"))]
pub mod fuzzy;

#[cfg(any(feature = "strsim", feature = "eddie", feature = "rapidfuzz"))]
pub use crate::simple::internal::fuzzers::fuzzy::Fuzzy;

// -----------------------------------------------------------------------------
//
// Used for tracking the top string similarity scores for (fuzzy matching) user
// keywords that are not found in the search index.

#[cfg(any(feature = "strsim", feature = "eddie", feature = "rapidfuzz"))]
pub mod fuzzy_top_scores;

#[cfg(any(feature = "strsim", feature = "eddie", feature = "rapidfuzz"))]
pub use crate::simple::internal::fuzzers::fuzzy_top_scores::FuzzyTopScores;