Enum DistanceMetric 

#[non_exhaustive]
pub enum DistanceMetric {
    Cosine,
    L2,
    InnerProduct,
    Hamming,
    Jaccard,
}

Distance metric for vector similarity calculations.

Each metric has a corresponding pgvector operator:

• Cosine: <=> (most common for text embeddings)
• L2: <-> (Euclidean distance)
• InnerProduct: <#> (dot product, negate for similarity)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Cosine

Cosine distance (1 - cosine similarity). Best for normalized embeddings (OpenAI, most text embeddings). Operator: <=>

L2

L2 (Euclidean) distance. Good for image embeddings and when magnitude matters. Operator: <->

InnerProduct

Inner product (negative for similarity). Use when embeddings are already normalized and you want max inner product. Operator: <#>

Hamming

Hamming distance — the number of differing bits (#959). Binary vectors (FieldType::BitVector) only. Operator: <~>

Jaccard

Jaccard distance — 1 - |intersection| / |union| over set bits (#959). Binary vectors (FieldType::BitVector) only; unlike hamming it normalises by how many bits are set, so a sparse near-match beats a dense one. Operator: <%>

Implementations

impl DistanceMetric

pub const fn operator(&self) -> &'static str

Get the pgvector operator for this distance metric.

pub const fn name(&self) -> &'static str

The metric’s authoring name, as spelled in fraiseql.toml / the IR.

pub const fn is_binary(&self) -> bool

Whether this metric is defined over binary (bit) vectors rather than float ones — the property that decides which field type may carry it.

Trait Implementations

impl Clone for DistanceMetric

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DistanceMetric

impl Debug for DistanceMetric

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

Formats the value using the given formatter.

impl Default for DistanceMetric

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DistanceMetric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DistanceMetric

impl PartialEq for DistanceMetric

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DistanceMetric

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 DistanceMetric