Struct UsearchBackend 

pub struct UsearchBackend { /* private fields */ }

HNSW vector backend.

Implementations

impl UsearchBackend

pub fn new(dim: usize) -> Result<Self>

Create an in-memory HNSW index with default parameters.

pub fn with_config(dim: usize, cfg: UsearchBackendConfig) -> Result<Self>

Create with custom HNSW parameters.

pub fn open(path: &str, dim: usize) -> Result<Self>

Load a persisted backend: reads the usearch index at path and the {path}.meta.json sidecar. The HNSW parameters are assumed to match UsearchBackendConfig::default; for custom params use Self::open_with_config.

pub fn open_with_config( path: &str, dim: usize, cfg: UsearchBackendConfig, ) -> Result<Self>

Load with explicit HNSW parameters.

pub async fn save(&self, path: &str) -> Result<()>

Persist the index + sidecar. Writes {path}.meta.json next to path.

impl UsearchBackend

pub fn config(&self) -> UsearchBackendConfig

Expose the active config (for diagnostics).

Trait Implementations

impl VectorBackend for UsearchBackend

fn upsert<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, id: &'life1 str, embedding: &'life2 [f32], metadata: Metadata, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Upsert a vector with metadata. If id exists it is replaced.

fn search<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, query: &'life1 [f32], top_k: usize, filter: Option<&'life2 Filter>, ) -> Pin<Box<dyn Future<Output = Result<Vec<VectorHit>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Search for vectors similar to query, returning at most top_k hits that satisfy filter (pre-filter where supported).

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a vector by ID. No-op if absent.

fn dimension(&self) -> usize

The fixed dimension of vectors this backend accepts.