fuzzies 0.1.0

A fast, memory-mapped fuzzy search dictionary using FSTs and Levenshtein automata.
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

# Fuzzies

A high-performance fuzzy search library for Rust, leveraging Finite State Transducers (FST) and Levenshtein Automata for efficient dictionary lookups.

## Installation

```bash
# Add the dependency to your Cargo.toml
cargo add fuzzies
```

## Example

This library allows you to build a compact, memory-mapped FST from a file and perform fast, fuzzy searches (Levenshtein distance of 1).

```rust
use fuzzies::Dictionary;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 1. Build the dictionary from a text file (one word per line)
    // Note: The input file must be sorted lexicographically
    fuzzies::build("words.txt", "words.fst")?;

    // 2. Load the dictionary
    let dict = Dictionary::open("words.fst")?;

    // 3. Perform a fuzzy search
    let results = dict.search("aple")?;
    
    for result in results {
        println!("Found: {} (Exact: {})", result.key, result.is_exact);
    }

    // 4. Batch search (multithreaded)
    let queries = vec!["aple", "banna", "cheri"];
    let batch_results = dict.batch_search(&queries);

    Ok(())
}
```