Struct VectorIdMap 

pub struct VectorIdMap { /* private fields */ }

The node ↔ document bindings of every HNSW index, keyed by index key.

Implementations

impl VectorIdMap

pub fn new() -> Self

pub fn index(&self, index_key: &str) -> Option<&IndexIdMap>

The bindings of index_key, when it has any.

pub fn bind(&mut self, index_key: &str, doc_id: &str, node: u32) -> Option<u32>

Bind doc_id to node in index_key. Returns the node doc_id was bound to before, when different: the caller tombstones it.

pub fn node(&self, index_key: &str, doc_id: &str) -> Option<u32>

The node bound to doc_id in index_key.

pub fn doc_id(&self, index_key: &str, node: u32) -> Option<&str>

The document bound to node in index_key.

pub fn unbind_doc(&mut self, index_key: &str, doc_id: &str) -> Option<u32>

Remove the binding of doc_id in index_key. Returns its node.

pub fn unbind_node(&mut self, index_key: &str, node: u32) -> Option<String>

Remove the binding of node in index_key. Returns its document id.

pub fn attached_vectors( &self, collection: &str, doc_id: &str, ) -> AttachedVectors

The vectors bound to doc_id across the base index collection and its named indexes "{collection}:{field}".

pub fn remove_index(&mut self, index_key: &str)

Remove every binding of index_key.

pub fn replace_index(&mut self, index_key: &str, ids: IndexIdMap)

Replace every binding of index_key with ids.

pub fn len(&self) -> usize

Total bindings across every index.

pub fn is_empty(&self) -> bool

pub fn to_entries(&self) -> Vec<PersistedIdEntry>

The persisted layout: one ("{index_key}:{node}", doc_id, node) per binding.

pub fn from_entries( entries: Vec<PersistedIdEntry>, ) -> (Self, Vec<(String, u32)>)

Rebuild from the persisted layout.

The index key is the composite key minus its ":{node}" suffix; an entry whose composite key does not end in its own node id is skipped. When one document holds several nodes in one index, the highest node wins: node ids grow with each insert, so it is the latest vector. The other nodes are returned as (index_key, node) for the caller to tombstone.

Trait Implementations

impl Clone for VectorIdMap

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VectorIdMap

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

Formats the value using the given formatter.

impl Default for VectorIdMap

fn default() -> Self

Returns the “default value” for a type.