Skip to main content

IvfIndex

Struct IvfIndex 

Source
pub struct IvfIndex { /* private fields */ }
Expand description

A concrete IVF vector index implementation.

Implementations§

Source§

impl IvfIndex

Source

pub fn create( storage: Arc<dyn Storage>, name: &str, config: IvfIndexConfig, ) -> Result<Self>

Create a new IVF index in the given storage.

Source

pub fn open( storage: Arc<dyn Storage>, name: &str, config: IvfIndexConfig, ) -> Result<Self>

Open an existing IVF index from storage.

Source

pub fn create_in_dir<P: AsRef<Path>>( dir: P, name: &str, config: IvfIndexConfig, ) -> Result<Self>

Create an index in a directory.

Source

pub fn open_dir<P: AsRef<Path>>( dir: P, name: &str, config: IvfIndexConfig, ) -> Result<Self>

Open an index from a directory.

Trait Implementations§

Source§

impl Debug for IvfIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl VectorIndex for IvfIndex

Source§

fn close(&self) -> Result<()>

Mark the index as closed.

Callers must call commit() before close() to persist pending data.

Source§

fn reader(&self) -> Result<Arc<dyn VectorIndexReader>>

Get a reader for this index. Read more
Source§

fn writer(&self) -> Result<Box<dyn VectorIndexWriter>>

Get a writer for this index. Read more
Source§

fn storage(&self) -> &Arc<dyn Storage>

Get the storage backend for this index. Read more
Source§

fn is_closed(&self) -> bool

Check if the index is closed. Read more
Source§

fn stats(&self) -> Result<VectorIndexStats>

Get index statistics. Read more
Source§

fn optimize(&self) -> Result<()>

Optimize the index. Read more
Source§

fn searcher(&self) -> Result<Box<dyn VectorIndexSearcher>>

Create a searcher tailored for this index implementation. Read more
Source§

fn embedder(&self) -> Arc<dyn Embedder>

Get the embedder associated with this index. Read more
Source§

fn refresh(&self) -> Result<()>

Refresh the index metadata from storage. Read more
Source§

fn last_wal_seq(&self) -> u64

Get the last processed WAL sequence number.
Source§

fn set_last_wal_seq(&self, _seq: u64) -> Result<()>

Set the last processed WAL sequence number.

Auto Trait Implementations§

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.