Struct TextIndexParams 

pub struct TextIndexParams {
    pub type: TextIndexType,
    pub tokenizer: TokenizerType,
    pub min_token_len: Option<usize>,
    pub max_token_len: Option<usize>,
    pub lowercase: Option<bool>,
    pub ascii_folding: Option<bool>,
    pub phrase_matching: Option<bool>,
    pub stopwords: Option<StopwordsInterface>,
    pub on_disk: Option<bool>,
    pub memory: Option<Memory>,
    pub stemmer: Option<StemmingAlgorithm>,
    pub enable_hnsw: Option<bool>,
}

Fields

type: TextIndexType

tokenizer: TokenizerType

min_token_len: Option<usize>

Minimum characters to be tokenized.

max_token_len: Option<usize>

Maximum characters to be tokenized.

lowercase: Option<bool>

If true, lowercase all tokens. Default: true.

ascii_folding: Option<bool>

If true, normalize tokens by folding accented characters to ASCII (e.g., “ação” -> “acao”). Default: false.

phrase_matching: Option<bool>

If true, support phrase matching. Default: false.

stopwords: Option<StopwordsInterface>

Ignore this set of tokens. Can select from predefined languages and/or provide a custom set.

on_disk: Option<bool>

👎Deprecated since 1.19.0:

Use memory instead

Deprecated: use memory instead. If true, store the index on disk. Default: false.

memory: Option<Memory>

Memory placement of the index. Overrides the deprecated on_disk flag if both are set. Default: pinned (cold if on_disk is set to true).

stemmer: Option<StemmingAlgorithm>

Algorithm for stemming. Default: disabled.

enable_hnsw: Option<bool>

Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.

Trait Implementations

impl Clone for TextIndexParams

fn clone(&self) -> TextIndexParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextIndexParams

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

Formats the value using the given formatter.

impl Default for TextIndexParams

fn default() -> TextIndexParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextIndexParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TextIndexParams

impl Hash for TextIndexParams

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for TextIndexParams

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for TextIndexParams

fn eq(&self, other: &TextIndexParams) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TextIndexParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextIndexParams

impl TryFrom<&PayloadFieldSchema> for TextIndexParams

fn try_from(schema: &PayloadFieldSchema) -> Result<Self, Self::Error>

Extracts the full-text tokenizer params from a payload schema — used by the read-only full-text index open, the only index whose read behavior depends on its build-time config. Errors if the schema is not a text index.

type Error = OperationError

The type returned in the event of a conversion error.