Struct VectorIndex 

pub struct VectorIndex { /* private fields */ }

Wraps usearch::Index and a key-map behind a single std::sync::Mutex.

usearch::Index is Send + Sync, and HashMap is Send, so VectorIndex is Send + Sync via the mutex.

Implementations

impl VectorIndex

pub fn new(dimensions: usize) -> Result<Self, MemoryError>

Create a new HNSW index with cosine metric.

pub fn grow_if_needed(&self, additional: usize) -> Result<(), MemoryError>

Ensure the index has capacity for at least additional more vectors.

pub fn find_key_by_name(&self, name: &str) -> Option<u64>

Find the vector key associated with a qualified memory name.

pub fn add_with_next_key( &self, vector: &[f32], name: String, ) -> Result<u64, MemoryError>

Atomically allocate the next key and add the vector in one lock acquisition. Returns the assigned key on success. On failure the counter is not advanced.

pub fn search( &self, query: &[f32], limit: usize, ) -> Result<Vec<(u64, String, f32)>, MemoryError>

Search for the limit nearest neighbours of query.

Returns (key, distance) pairs sorted by ascending distance.

pub fn remove(&self, key: u64) -> Result<(), MemoryError>

Remove a vector by key.

pub fn commit_sha(&self) -> Option<String>

Return the commit SHA stored in the index metadata (if any).

pub fn set_commit_sha(&self, sha: Option<&str>)

Set the commit SHA in the index metadata.

pub fn save(&self, path: &Path) -> Result<(), MemoryError>

Persist the index to path. Also writes <path>.keys.json.

If commit_sha is Some, it is written to the metadata alongside the key map so the next load can verify freshness.

pub fn load(path: &Path) -> Result<Self, MemoryError>

Load an existing index from path. Also reads <path>.keys.json.