Struct faiss::index::Idx

source · [−]

#[repr(transparent)]
pub struct Idx(_);

Expand description

Primitive data type for identifying a vector in an index (or lack thereof).

Depending on the kind of index, it may be possible for vectors to share the same ID.

Implementations

source

impl Idx

source

pub fn new(idx: u64) -> Self

Create a vector identifier.

Panic

Panics if the ID is too large (>= 2^63)

source

pub fn none() -> Self

Create an identifier referring to no vector.

source

pub fn is_none(self) -> bool

Check whether the vector identifier does not point to anything.

source

pub fn is_some(self) -> bool

Check whether the vector identifier is not “none”.

source

pub fn get(self) -> Option<u64>

Retrieve the vector identifier as a primitive unsigned integer.

source

pub fn to_native(self) -> idx_t

Convert the vector identifier into a native idx_t value.

Trait Implementations

source

impl Clone for Idx

source

fn clone(&self) -> Idx

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Idx

source

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

Formats the value using the given formatter. Read more

source

impl Display for Idx

source

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

Formats the value using the given formatter. Read more

source

impl From<i64> for Idx

source

fn from(x: idx_t) -> Self

Converts to this type from the input type.

source

impl PartialEq<Idx> for Idx

This comparison is not entirely reflexive: it returns always false if at least one of the values is a none.

source

fn eq(&self, idx: &Idx) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

source

impl PartialOrd<Idx> for Idx

This comparison is not entirely reflexive: it returns always None if at least one of the values is a none.

source

fn partial_cmp(&self, idx: &Idx) -> Option<Ordering>

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl Copy for Idx

Auto Trait Implementations

impl RefUnwindSafe for Idx

impl Send for Idx

impl Sync for Idx

impl Unpin for Idx

impl UnwindSafe for Idx

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct faiss::index::Idx

Implementations

impl Idx

pub fn new(idx: u64) -> Self

Panic

pub fn none() -> Self

pub fn is_none(self) -> bool

pub fn is_some(self) -> bool

pub fn get(self) -> Option<u64>

pub fn to_native(self) -> idx_t

Trait Implementations

impl Clone for Idx

fn clone(&self) -> Idx

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

impl Debug for Idx

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

impl Display for Idx

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

impl From<i64> for Idx

fn from(x: idx_t) -> Self

impl PartialEq<Idx> for Idx

fn eq(&self, idx: &Idx) -> bool

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

impl PartialOrd<Idx> for Idx

fn partial_cmp(&self, idx: &Idx) -> Option<Ordering>

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

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

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

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

impl Copy for Idx

Auto Trait Implementations

impl RefUnwindSafe for Idx

impl Send for Idx

impl Sync for Idx

impl Unpin for Idx

impl UnwindSafe for Idx

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,