Struct VectorIndex

pub struct VectorIndex {
    pub spec_version: u32,
    pub dimension: u32,
    pub stages: Vec<VectorIndexStage>,
    pub metric_type: i32,
}

Vector Index Metadata

Fields

spec_version: u32

Index specification version.

dimension: u32

Vector dimension;

stages: Vec<VectorIndexStage>

Composed vector index stages.

For example, IVF_PQ index type can be expressed as:

let stages = vec!\[Ivf{}, PQ{num_bits: 8, num_sub_vectors: 16}\]

metric_type: i32

Vector distance metrics type

Implementations

impl VectorIndex

pub fn metric_type(&self) -> VectorMetricType

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

pub fn set_metric_type(&mut self, value: VectorMetricType)

Sets metric_type to the provided enum value.

Trait Implementations

impl Clone for VectorIndex

fn clone(&self) -> VectorIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VectorIndex

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

Formats the value using the given formatter.

impl Default for VectorIndex

fn default() -> Self

Returns the “default value” for a type.

impl Message for VectorIndex

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 VectorIndex

fn eq(&self, other: &VectorIndex) -> 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 StructuralPartialEq for VectorIndex