Struct JsonIndexerOptions 

pub struct JsonIndexerOptions {
    pub prefix: String,
    pub term_filters: Vec<TokenFilter>,
    pub array_index_mode: ArrayIndexMode,
    pub mode: SteVecMode,
}

Configuration for a JsonIndexer.

JsonIndexerOptions controls how a JSON document is tokenized and indexed. It can be constructed directly, or derived from a column configuration via TryFrom<&column::IndexType>.

Fields

prefix: String

Domain-separation prefix mixed into the keyed MAC used to tokenize JSON paths and values.

Two indexers with the same key but different prefixes will produce disjoint token spaces, so the prefix must match between the indexing side and the query side for results to be comparable. In practice this is set to a stable column identifier (e.g. "cs_ste_vec_v1").

term_filters: Vec<TokenFilter>

Term filters applied to every string leaf node before indexing.

Filters run in order against each string value (e.g. Downcase, Stemmer, Stop). If any filter rejects a term by returning None, the string is replaced with Value::Null rather than indexed. To match at query time, the same filters must be applied to the query plaintext.

array_index_mode: ArrayIndexMode

Controls which selectors are emitted for array entries.

See ArrayIndexMode — ALL emits item, positional, and wildcard selectors for each element; narrower modes (ITEM, POSITION, WILDCARD, NONE) reduce index size at the cost of which query shapes are supported.

mode: SteVecMode

Selects the STE-vec encoding scheme used by this indexer.

See SteVecMode — the mode selects the orderable-term primitive: Standard (the default) uses ORE, Compat uses OPE. Selectors are always Blake3-keyed and term-side MACs are always HMAC-SHA256 in both modes. Indexes produced under different modes are not cross-comparable, so the indexing side and the query side must agree on the mode for results to match.

Trait Implementations

impl Debug for JsonIndexerOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JsonIndexerOptions

fn default() -> JsonIndexerOptions

Returns the “default value” for a type.

impl TryFrom<&IndexType> for JsonIndexerOptions

type Error = EncryptionError

The type returned in the event of a conversion error.

fn try_from(value: &IndexType) -> Result<Self, Self::Error>

Performs the conversion.