Enum VectorMetric 

#[repr(i32)]
pub enum VectorMetric {
    Cosine = 0,
    Dot = 1,
    Euclidean = 2,
}

Variants

Cosine = 0

Dot = 1

Euclidean = 2

Implementations

impl VectorMetric

pub const fn is_valid(value: i32) -> bool

Returns true if value is a variant of VectorMetric.

pub fn from_i32(value: i32) -> Option<VectorMetric>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a VectorMetric, or None if value is not a valid variant.

impl VectorMetric

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for VectorMetric

fn clone(&self) -> VectorMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VectorMetric

impl Debug for VectorMetric

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

Formats the value using the given formatter.

impl Default for VectorMetric

fn default() -> VectorMetric

Returns the “default value” for a type.

impl Eq for VectorMetric

impl From<VectorMetric> for i32

fn from(value: VectorMetric) -> i32

Converts to this type from the input type.

impl Hash for VectorMetric

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VectorMetric

fn cmp(&self, other: &VectorMetric) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VectorMetric

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VectorMetric

fn partial_cmp(&self, other: &VectorMetric) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for VectorMetric

impl TryFrom<i32> for VectorMetric

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<VectorMetric, UnknownEnumValue>

Performs the conversion.