Struct IndexIdMap 

pub struct IndexIdMap { /* private fields */ }

The node ↔ document bindings of one HNSW index.

Implementations

impl IndexIdMap

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

Bind doc_id to node. Returns the node doc_id was bound to before, when that was a different node: the caller tombstones it. A document previously bound to node loses its binding.

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

The node bound to doc_id.

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

The document bound to node.

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

Remove the binding of doc_id. Returns its node.

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

Remove the binding of node. Returns its document id.

pub fn len(&self) -> usize

Number of bound documents.

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = (&str, u32)>

Every (doc_id, node) binding, in no fixed order.

Trait Implementations

impl Clone for IndexIdMap

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 IndexIdMap

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

Formats the value using the given formatter.

impl Default for IndexIdMap

fn default() -> Self

Returns the “default value” for a type.