Trait VectorIndexEngine 

pub trait VectorIndexEngine: Send + Sync {
    // Required methods
    fn add(&mut self, key: u64, vector: &[f32]) -> Result<(), BoxedError>;
    fn search(
        &self,
        query: &[f32],
        k: usize,
    ) -> Result<VectorSearchMatches, BoxedError>;
    fn serialized_length(&self) -> usize;
    fn save_to_buffer(&self, buffer: &mut [u8]) -> Result<(), BoxedError>;
    fn reserve(&mut self, capacity: usize) -> Result<(), BoxedError>;
    fn size(&self) -> usize;
    fn capacity(&self) -> usize;
    fn memory_usage(&self) -> usize;
}

Trait for vector index engines (HNSW implementations).

This trait defines the interface for pluggable vector index engines. Implementations (e.g., UsearchEngine) are provided by storage engines like mito2.

Required Methods

fn add(&mut self, key: u64, vector: &[f32]) -> Result<(), BoxedError>

Adds a vector with the given key.

fn search( &self, query: &[f32], k: usize, ) -> Result<VectorSearchMatches, BoxedError>

Searches for k nearest neighbors.

fn serialized_length(&self) -> usize

Returns the serialized length.

fn save_to_buffer(&self, buffer: &mut [u8]) -> Result<(), BoxedError>

Serializes the index to a buffer.

fn reserve(&mut self, capacity: usize) -> Result<(), BoxedError>

Reserves capacity for vectors.

fn size(&self) -> usize

Returns current size (number of vectors).

fn capacity(&self) -> usize

Returns current capacity.

fn memory_usage(&self) -> usize

Returns memory usage in bytes.

Implementors