Struct BinaryVectorIndex 

pub struct BinaryVectorIndex {
    pub name: String,
    pub table: String,
    pub column: String,
    pub metric: BinaryDistanceMetric,
    pub hnsw_config: HnswConfig,
    pub concurrent: bool,
}

A binary vector index definition.

Fields

name: String

Index name.

table: String

Table name.

column: String

Column name.

metric: BinaryDistanceMetric

Distance metric.

hnsw_config: HnswConfig

HNSW configuration (only HNSW is supported for bit vectors).

concurrent: bool

Whether to create concurrently.

Implementations

impl BinaryVectorIndex

pub fn new( name: impl Into<String>, table: impl Into<String>, column: impl Into<String>, ) -> BinaryVectorIndexBuilder

Create a new binary vector index builder.

pub fn to_create_sql(&self) -> String

Generate the CREATE INDEX SQL.

Trait Implementations

impl Clone for BinaryVectorIndex

fn clone(&self) -> BinaryVectorIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryVectorIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BinaryVectorIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BinaryVectorIndex

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BinaryVectorIndex

impl StructuralPartialEq for BinaryVectorIndex