Rust API reference

Rustdoc is the authoritative reference for signatures, trait implementations, error types and exact edge-case behaviour. The guides on this site cover what rustdoc cannot: which API to reach for, how the variants differ, and what each one costs.

Crates

Crate	What is in it	Guide	Rustdoc
verbora-core	The 5 shared traits, StopWords, StopWordLanguage, the process-global stop-word list	Core vocabulary	API
verbora-tokenizers	3 UAX #29 tokenizers behind one borrowing trait	Tokenizers	API
verbora-distance	7 metrics: Levenshtein, unrestricted Damerau, OSA, Jaro, Jaro–Winkler, Dice, Hamming	String distance	API
verbora-phonetics	12 encoders (SoundEx, Metaphone, Double Metaphone, Daitch–Mokotoff, Beider–Morse and the rest), plus PhoneticIndex	Phonetics	API
verbora-ngrams	Slice windows, boundary padding, character n-grams	N-grams	API
verbora-normalizers	The four Unicode normalization forms and diacritic folding, all Cow	Normalizers	API
verbora-inflectors	Pluralise, singularise, ordinals (en / fr / ja)	Inflectors	API
verbora-trie	Prefix tree with prefix, longest-prefix and prefix-match queries, plus FrozenTrie	Trie	API
verbora-transliterators	Japanese kana → romaji	Transliterators	API
verbora-wordnet	Synsets, senses, relation traversal, four storage backends	WordNet	API
verbora-tfidf	Sparse TF-IDF over an owned Analyzer, ranking and JSON persistence	TF-IDF	API
verbora-sentiment	14 lexicons across 10 languages	Sentiment	API
verbora-classifiers	Naive Bayes, logistic regression, MaxEnt	Classifiers	API
verbora-stemmers	Porter/Snowball, Lancaster, Japanese, Indonesian	Stemmers	API
verbora-spellcheck	Norvig correction, a BK-tree FuzzyIndex and a DeletionIndex	Spellcheck	API
verbora-tagger	Brill POS tagging engine, trainer and evaluation	POS tagger	API
verbora-analyzers	Sentence structure analysis	Sentence analyzers	API
verbora-language	Script detection, optional language detectors, phonetic recommendations	Language	API
verbora-util	Stop-word re-exports, abbreviations, graphs, path trees, topological ordering	Utilities	API

Reading the docs locally

The /api/ links above are populated on the deployed site. Against a local checkout, generate rustdoc yourself:

cargo doc --workspace --no-deps --open

How the two layers divide the work

• Rustdoc defines behaviour, invariants and error conditions per item. Its examples run as doctests unless explicitly marked otherwise, so what you read there compiles and passes.
• This site covers selection, composition, allocation behaviour and workload trade-offs — the questions a signature cannot answer.

Where to go next

You want	Go to
To move code from 0.1 to 0.2	Upgrading from 0.1 to 0.2
To pick between several similar APIs	Choosing the right API
Allocation, laziness, batching and parallelism	Performance
Measured numbers and how they were produced	Benchmarks
The snippets on this site, as compilable code	crates/verbora-examples/examples/