Struct VectorIndexReaderDesc 

pub struct VectorIndexReaderDesc {
    pub table_id: TableId,
    pub info_column_desc: Vec<ColumnDesc>,
    pub info_output_indices: Vec<u32>,
    pub include_distance: bool,
    pub top_n: u32,
    pub distance_type: i32,
    pub hnsw_ef_search: u32,
}

Fields

table_id: TableId

The table_id of the vector index to search.

info_column_desc: Vec<ColumnDesc>

The columns of the vector index info.

info_output_indices: Vec<u32>

include_distance: bool

Whether or not to include the distance column in the output

top_n: u32

The number of nearest neighbors to return.

distance_type: i32

The distance metric to use for the search.

hnsw_ef_search: u32

The ef_search used to query hnsw index

Implementations

impl VectorIndexReaderDesc

pub fn distance_type(&self) -> DistanceType

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

pub fn set_distance_type(&mut self, value: DistanceType)

Sets distance_type to the provided enum value.

impl VectorIndexReaderDesc

pub fn get_table_id(&self) -> TableId

pub fn get_info_column_desc(&self) -> &Vec<ColumnDesc>

pub fn get_info_output_indices(&self) -> &Vec<u32>

pub fn get_include_distance(&self) -> bool

pub fn get_top_n(&self) -> u32

pub fn get_distance_type(&self) -> Result<DistanceType, PbFieldNotFound>

pub fn get_hnsw_ef_search(&self) -> u32

Trait Implementations

impl Clone for VectorIndexReaderDesc

fn clone(&self) -> VectorIndexReaderDesc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorIndexReaderDesc

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

Formats the value using the given formatter.

impl Default for VectorIndexReaderDesc

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VectorIndexReaderDesc

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for VectorIndexReaderDesc

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 VectorIndexReaderDesc

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

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 VectorIndexReaderDesc