Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Add the crate to your Cargo.toml:

[dependencies]
fuzzy-aho-corasick = "0.4"

Or with cargo add:

cargo add fuzzy-aho-corasick

The crate has a single runtime dependency (unicode-segmentation) and builds on stable Rust (edition 2024).

Then bring the common types into scope:

use fuzzy_aho_corasick::{FuzzyAhoCorasickBuilder, FuzzyLimits};

The most useful items are re-exported at the crate root:

ItemRole
FuzzyAhoCorasickBuilderConfigure and build an engine.
FuzzyAhoCorasickThe immutable engine you query.
FuzzyLimitsEdit-count limits (global or per-pattern).
FuzzyPenaltiesPer-edit-type cost tuning.
PatternA pattern with optional weight / limits / id.
FuzzyMatchA single match result.
FuzzyReplacerTurnkey find-and-replace.

Everything else (the similarity table type, streaming match type, and so on) lives under the same crate root or the structs module.