Struct KeywordIndexParams 

pub struct KeywordIndexParams {
    pub is_tenant: Option<bool>,
    pub on_disk: Option<bool>,
    pub enable_hnsw: Option<bool>,
    pub prefix: Option<KeywordPrefixParams>,
    pub memory: Option<i32>,
}

Fields

is_tenant: Option<bool>

If true - used for tenant optimization.

on_disk: Option<bool>

👎Deprecated

Deprecated: use memory instead. If true - store index on disk.

enable_hnsw: Option<bool>

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

prefix: Option<KeywordPrefixParams>

If set, enable prefix matching (match: { "prefix": ... }) on this field.

memory: Option<i32>

Memory placement of the index. Overrides the deprecated on_disk flag if both are set.

Implementations

impl KeywordIndexParams

pub fn is_tenant(&self) -> bool

Returns the value of is_tenant, or the default value if is_tenant is unset.

pub fn on_disk(&self) -> bool

Returns the value of on_disk, or the default value if on_disk is unset.

pub fn enable_hnsw(&self) -> bool

Returns the value of enable_hnsw, or the default value if enable_hnsw is unset.

pub fn memory(&self) -> Memory

Returns the enum value of memory, or the default if the field is unset or set to an invalid enum value.

pub fn set_memory(&mut self, value: Memory)

Sets memory to the provided enum value.

Trait Implementations

impl Clone for KeywordIndexParams

fn clone(&self) -> KeywordIndexParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeywordIndexParams

impl Debug for KeywordIndexParams

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

Formats the value using the given formatter.

impl Default for KeywordIndexParams

fn default() -> Self

Returns the “default value” for a type.

impl Eq for KeywordIndexParams

impl From<KeywordIndexParams> for IndexParams

fn from(value: KeywordIndexParams) -> Self

Converts to this type from the input type.

impl From<KeywordIndexParamsBuilder> for KeywordIndexParams

fn from(value: KeywordIndexParamsBuilder) -> Self

Converts to this type from the input type.

impl Hash for KeywordIndexParams

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 Message for KeywordIndexParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for KeywordIndexParams

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeywordIndexParams