Struct SparseIndexConfig

pub struct SparseIndexConfig {
    pub full_scan_threshold: Option<u64>,
    pub on_disk: Option<bool>,
    pub datatype: Option<i32>,
}

Fields

full_scan_threshold: Option<u64>

Prefer a full scan search upto (excluding) this number of vectors. Note: this is number of vectors, not KiloBytes.

on_disk: Option<bool>

Store inverted index on disk. If set to false, the index will be stored in RAM.

datatype: Option<i32>

Datatype used to store weights in the index.

Implementations

impl SparseIndexConfig

pub fn full_scan_threshold(&self) -> u64

Returns the value of full_scan_threshold, or the default value if full_scan_threshold 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 datatype(&self) -> Datatype

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

pub fn set_datatype(&mut self, value: Datatype)

Sets datatype to the provided enum value.

Trait Implementations

impl Clone for SparseIndexConfig

fn clone(&self) -> SparseIndexConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SparseIndexConfig

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

Formats the value using the given formatter.

impl Default for SparseIndexConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<SparseIndexConfig> for SparseVectorParams

fn from(value: SparseIndexConfig) -> Self

Converts to this type from the input type.

impl From<SparseIndexConfigBuilder> for SparseIndexConfig

fn from(value: SparseIndexConfigBuilder) -> Self

Converts to this type from the input type.

impl Message for SparseIndexConfig

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 SparseIndexConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SparseIndexConfig

impl StructuralPartialEq for SparseIndexConfig