simsearch 0.4.0

A small in-memory fuzzy search index for embedded autocomplete and search suggestions.
Documentation

simsearch

CI crates.io docs.rs MSRV 1.85.0

A small in-memory fuzzy search index for embedded autocomplete and search suggestions.

Documentation

Usage

Add the following to your Cargo.toml:

[dependencies]
simsearch = "0.4"

Example

use simsearch::Index;

let mut engine: Index<u32> = Index::new();

engine.insert(1, "Things Fall Apart");
engine.insert(2, "The Old Man and the Sea");
engine.insert(3, "James Joyce");

let results = engine.search("thngs");

assert_eq!(results[0].id, 1);
assert!(results[0].score > 0.0);

You can also try the interactive demo:

cargo run --release --example books

Contributing

Contributions are welcome.

  • Issues. Open an issue if you find a typo, hit a bug, or have a question.
  • Pull requests. New collections, implementation improvements, tests, documentation, and typo fixes are welcome.

License

Licensed under the MIT license (LICENSE or http://opensource.org/licenses/MIT).