Lib.rs

Cargo Features

[dependencies]
tantivy-analysis-contrib = { version = "0.12.5", default-features = false, features = ["icu", "commons", "phonetic", "embedded", "embedded_bm", "embedded_dm"] }

default = commons, icu, phonetic

These default features are set whenever tantivy-analysis-contrib is added without default-features = false somewhere in the dependency tree.

icu default = rust_icu_common, rust_icu_sys, rust_icu_ubrk, rust_icu_unorm2, rust_icu_utrans

General components
ICU components. It needs libicu-dev and clang installed.

Affects tantivy-analysis-contrib::icu…

commons default = derive_builder, either, fst

Miscellaneous components

Affects tantivy-analysis-contrib::commons…

phonetic default = rphonetic

Phonetic
Phonetic token filters

Affects tantivy-analysis-contrib::phonetic…

embedded = embedded_bm, embedded_dm

Default phonetic rules. It enables embedded_bm and embedded_dm

embedded_bm embedded?

Include Beider-Morse rules.

Enables embedded_bm of rphonetic

Phonetic

embedded_dm embedded?

Include Daitch-Mokotoff rules.

Enables embedded_dm of rphonetic

Affects types::DMRule…

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

rust_icu_sys icu

Enables rust_icu_sys

Switch to full icu lib when possible

rust_icu_unorm2 icu

rust_icu_ubrk icu

rust_icu_utrans icu

rust_icu_common icu

rphonetic embedded_bm? embedded_dm? phonetic

fst commons

Enables fst

Automaton

derive_builder commons

either commons