Enum Index

#[non_exhaustive]
pub enum Index {
    Idx,
    Uniq,
    Search(SearchParams),
    MTree(MTreeParams),
    Hnsw(HnswParams),
}

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.

Idx

(Basic) non unique

Uniq

Unique index

Search(SearchParams)

Index with Full-Text search capabilities

MTree(MTreeParams)

M-Tree index for distance based metrics

Hnsw(HnswParams)

HNSW index for distance based metrics

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Index

fn deserialize<__D>( __deserializer: __D, ) -> Result<Index, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Index

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

Formats the value using the given formatter.

impl Hash for Index

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

where __H: Hasher,

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 PartialEq for Index

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

fn partial_cmp(&self, other: &Index) -> 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 Revisioned for Index

fn revision() -> u16

Returns the current revision of this type.

fn serialize_revisioned<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

Serializes the struct using the specficifed writer.

fn deserialize_revisioned<R>(reader: &mut R) -> Result<Index, Error>

where R: Read,

Deserializes a new instance of the struct from the specficifed reader.

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

impl Serialize for Index

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Index

impl StructuralPartialEq for Index