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	Shared traits, Token, stop words, whitespace helpers	Core vocabulary	API
verbora-tokenizers	25 tokenizers behind one Tokenize trait	Tokenizers	API
verbora-distance	8 metrics: Levenshtein, Damerau, Jaro–Winkler, Dice, Hamming	String distance	API
verbora-phonetics	SoundEx, Metaphone, Double Metaphone, Daitch–Mokotoff	Phonetics	API
verbora-ngrams	n-gram windows, frequency statistics, Chinese n-grams	N-grams	API
verbora-normalizers	Diacritics, English contractions, Japanese width and kana	Normalizers	API
verbora-inflectors	Pluralise, singularise, ordinals (en / fr / ja)	Inflectors	API
verbora-trie	Prefix tree with prefix and on-path queries	Trie	API
verbora-transliterators	Japanese kana → romaji	Transliterators	API
verbora-wordnet	Synsets, senses, relation traversal, four storage backends	WordNet	API
verbora-tfidf	Term interning and an incremental idf cache	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	Correction, BK-tree and deletion index	Spellcheck	API
verbora-tagger	Brill POS tagger, trainer and tester	POS tagger	API
verbora-analyzers	Sentence structure analysis	Sentence analyzers	API
verbora-language	Script and language detection	Language	API
verbora-util	Stop words, abbreviations, graphs, storage backends	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 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/