Struct SearchIndex 

pub struct SearchIndex {
    pub name: String,
    pub prefix: String,
    pub fields: Vec<SearchField>,
}

Search index definition

Fields

name: String

Index name (will be prefixed with “idx:”)

prefix: String

Key prefix this index covers (e.g., “crdt:users:”)

fields: Vec<SearchField>

Field definitions for the index

Implementations

impl SearchIndex

pub fn new(name: impl Into<String>, prefix: impl Into<String>) -> Self

Create a new search index definition

pub fn text(self, name: impl Into<String>) -> Self

Add a text field

pub fn text_at( self, name: impl Into<String>, json_path: impl Into<String>, ) -> Self

Add a text field with custom JSON path

pub fn text_sortable(self, name: impl Into<String>) -> Self

Add a sortable text field

pub fn text_sortable_at( self, name: impl Into<String>, json_path: impl Into<String>, ) -> Self

Add a sortable text field with custom JSON path

pub fn numeric(self, name: impl Into<String>) -> Self

Add a numeric field

pub fn numeric_at( self, name: impl Into<String>, json_path: impl Into<String>, ) -> Self

Add a numeric field with custom JSON path

pub fn numeric_sortable(self, name: impl Into<String>) -> Self

Add a sortable numeric field

pub fn numeric_sortable_at( self, name: impl Into<String>, json_path: impl Into<String>, ) -> Self

Add a sortable numeric field with custom JSON path

pub fn tag(self, name: impl Into<String>) -> Self

Add a tag field

pub fn tag_at( self, name: impl Into<String>, json_path: impl Into<String>, ) -> Self

Add a tag field with custom JSON path

pub fn geo(self, name: impl Into<String>) -> Self

Add a geo field

pub fn geo_at( self, name: impl Into<String>, json_path: impl Into<String>, ) -> Self

Add a geo field with custom JSON path

pub fn vector_hnsw( self, name: impl Into<String>, dim: usize, metric: DistanceMetric, ) -> Self

Add an HNSW vector field for similarity search.

HNSW (Hierarchical Navigable Small World) is an approximate nearest neighbors algorithm that provides fast queries with good recall.

Arguments

• name - Field name
• dim - Vector dimensionality (must match your embeddings)
• metric - Distance metric (L2, InnerProduct, or Cosine)

Example

SearchIndex::new("docs", "crdt:docs:")
    .vector_hnsw("embedding", 1536, DistanceMetric::Cosine)

pub fn vector_hnsw_at( self, name: impl Into<String>, json_path: impl Into<String>, dim: usize, metric: DistanceMetric, ) -> Self

Add an HNSW vector field with custom JSON path.

pub fn vector_with_params( self, name: impl Into<String>, params: VectorParams, ) -> Self

Add an HNSW vector field with tuned parameters.

Arguments

• name - Field name
• params - Pre-configured VectorParams with custom M and EF_CONSTRUCTION

Example

let params = VectorParams::hnsw(1536, DistanceMetric::Cosine)
    .with_m(32)
    .with_ef_construction(400);

SearchIndex::new("docs", "crdt:docs:")
    .vector_with_params("embedding", params)

pub fn vector_flat( self, name: impl Into<String>, dim: usize, metric: DistanceMetric, ) -> Self

Add a FLAT vector field for exact similarity search.

FLAT is a brute-force algorithm with O(n) query time but provides exact results. Good for smaller datasets (<10k vectors).

Arguments

• name - Field name
• dim - Vector dimensionality (must match your embeddings)
• metric - Distance metric (L2, InnerProduct, or Cosine)

pub fn vector_flat_at( self, name: impl Into<String>, json_path: impl Into<String>, dim: usize, metric: DistanceMetric, ) -> Self

Add a FLAT vector field with custom JSON path.

pub fn to_ft_create_args(&self) -> Vec<String>

Generate the FT.CREATE command arguments

pub fn to_ft_create_args_with_prefix( &self, redis_prefix: Option<&str>, ) -> Vec<String>

Generate FT.CREATE args with optional global redis prefix

The redis_prefix is prepended to both the index name and the key prefix to match the actual key structure in Redis.

Trait Implementations

impl Clone for SearchIndex

fn clone(&self) -> SearchIndex

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchIndex

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

Formats the value using the given formatter.