Cargo Features

[dependencies]
izihawa-tantivy = { version = "0.22.5", default-features = false, features = ["mmap", "stopwords", "lz4-compression", "zstd-compression", "failpoints", "unstable", "quickwit", "wasm", "compare_hash_only", "sstable-termdict"] }
default = lz4-compression, mmap, stopwords

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

mmap default = fs4, memmap2, tempfile, tokio
stopwords default
lz4-compression default = lz4_flex
zstd-compression = zstd
failpoints = fail

Enables failpoints of fail

unstable

useful for benches.

quickwit = futures-util

Enables quickwit of izihawa-tantivy-common

Affects custom_score_top_collector::CustomScorer.segment_scorer_async, collector::Collector.for_segment_async, collector::Collector.collect_segment_async, directory::Directory.open_read_async, directory::Directory.delete_async, directory::Directory.atomic_read_async, bm25::Bm25StatisticsProvider.total_num_tokens_async, query::Query.weight_async, query::Query.count_async, weight::Weight.scorer_async, weight::Weight.count_async, weight::Weight.for_each_async, weight::Weight.for_each_no_score_async, weight::Weight.for_each_pruning_async

wasm

Enables thin and wasm of zstd

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 izihawa-tantivy-stacker

sstable-termdict = sstable

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.

lz4_flex lz4-compression
memmap2 mmap
zstd wasm? zstd-compression?
tempfile mmap
tokio mmap
fs4 mmap

Enables fs4 ^0.7.0

fail failpoints?
sstable sstable-termdict?

Enables izihawa-tantivy-sstable

futures-util quickwit?