Struct MultiVectorIndex 

pub struct MultiVectorIndex { /* private fields */ }

Deterministic vector index allowing multiple vectors per caller key.

Implementations

impl MultiVectorIndex

pub fn build( config: IndexConfig, vectors: &[MultiVectorRef<'_>], ) -> Result<Self, SearchError>

Builds one HNSW node per unique (key, vector_id) pair.

Input order does not affect internal IDs or graph construction.

Errors

Returns typed config, vector, duplicate identity, capacity, or allocation errors.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub const fn dimensions(&self) -> usize

pub fn config(&self) -> &IndexConfig

pub fn estimated_memory_bytes(&self) -> usize

pub fn search( &self, query: &[f32], count: usize, ) -> Result<Vec<MultiSearchHit>, SearchError>

Returns top vectors, allowing repeated caller keys.

Errors

Returns a typed query or allocation error.

pub fn search_exact( &self, query: &[f32], count: usize, ) -> Result<Vec<MultiSearchHit>, SearchError>

Returns exact top vectors, allowing repeated caller keys.

Errors

Returns a typed query or allocation error.

pub fn search_unique_keys( &self, query: &[f32], count: usize, ) -> Result<Vec<MultiSearchHit>, SearchError>

Returns at most one best vector for each caller key.

The approximate pass widens candidates; an exact fallback fills sparse key distributions.

Errors

Returns a typed query or allocation error.

pub fn search_filtered<F>( &self, query: &[f32], count: usize, filter: F, ) -> Result<Vec<MultiSearchHit>, SearchError>

where F: Fn(MultiVectorKey) -> bool,

Searches only identities accepted by filter.

Errors

Returns a typed query or allocation error.

pub fn search_batch( &self, queries: &[&[f32]], count: usize, ) -> Result<Vec<Vec<MultiSearchHit>>, SearchError>

Searches independent queries with bounded workers.

Errors

Returns the first query or worker error.

impl MultiVectorIndex

pub fn to_bytes(&self) -> Result<Vec<u8>, SearchError>

Serializes the graph and caller-visible (key, vector_id) identities.

Errors

Returns a capacity or allocation error.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, SearchError>

Restores and validates a graph and its multi-vector identities.

Errors

Returns a format, integrity, graph, or allocation error.

pub fn write_to(&self, writer: impl Write) -> Result<(), SearchError>

Writes a complete multi-vector snapshot to a stream.

Errors

Returns a serialization or stream error.

pub fn read_from(reader: impl Read) -> Result<Self, SearchError>

Reads a complete multi-vector snapshot from a stream.

Errors

Returns a stream, format, or integrity error.

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), SearchError>

Atomically saves a complete multi-vector snapshot.

Errors

Returns a serialization or filesystem error.

pub fn load(path: impl AsRef<Path>) -> Result<Self, SearchError>

Loads a complete multi-vector snapshot.

Errors

Returns a filesystem, format, or integrity error.

Trait Implementations

impl Debug for MultiVectorIndex

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

Formats the value using the given formatter.