Lib.rs

Cargo Features

[dependencies]
tantivy = { version = "0.25.0", default-features = false, features = ["mmap", "stopwords", "lz4-compression", "zstd-compression", "columnar-zstd-compression", "failpoints", "unstable", "quickwit", "compare_hash_only"] }

default = columnar-zstd-compression, lz4-compression, mmap, stopwords

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

mmap default = fs4, memmap2, tempfile

stopwords default

lz4-compression default = lz4_flex

zstd-compression = zstd

columnar-zstd-compression default

enable zstd-compression in columnar (and sstable)

Enables zstd-compression of tantivy-columnar

failpoints = fail

Enables failpoints of fail

unstable

useful for benches.

quickwit = futures-channel, futures-util, sstable

compare_hash_only

Compares only the hash of a string when indexing data.
Increases indexing speed, but may lead to extremely rare missing terms, when there's a hash collision.
Uses 64bit ahash.

Enables compare_hash_only of tantivy-stacker

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.

memmap2 mmap

lz4_flex lz4-compression

zstd zstd-compression?

tempfile mmap

fs4 mmap

fail failpoints?

sstable quickwit?

Enables tantivy-sstable

futures-util quickwit?

futures-channel quickwit?