Struct VectorIndexes 

pub struct VectorIndexes(/* private fields */);

A table’s vector registrations. Retained collections own controlled ordered-map nodes and share their names, index handles and original allowance with nested captures. Live mutation requires an explicit fallible borrow; a retained collection never converts itself to an uncharged writable map.

Implementations

impl VectorIndexes

pub fn live_mut( &mut self, ) -> StorageBackendResult<&mut BTreeMap<FieldName, Box<dyn VectorIndex>>>

pub fn get<Q: Ord + ?Sized>( &self, field: &Q, ) -> Option<&(dyn VectorIndex + 'static)>

where FieldName: Borrow<Q>,

pub fn contains_key<Q: Ord + ?Sized>(&self, field: &Q) -> bool

where FieldName: Borrow<Q>,

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> VectorIndexesIter<'_>

pub fn keys(&self) -> impl ExactSizeIterator<Item = &FieldName>

pub fn values( &self, ) -> impl ExactSizeIterator<Item = &(dyn VectorIndex + 'static)>

pub fn capture( source: &dyn VectorIndexSource, control: &StorageReadControl, ) -> StorageBackendResult<Self>

Snapshot live providers under a caller allowance, or share an already retained collection without copying names, nodes or handles. Nested captures preserve the original provider allowance and cancellation boundary.

Trait Implementations

impl Default for VectorIndexes

fn default() -> Self

Returns the “default value” for a type.

impl From<BTreeMap<String, Box<dyn VectorIndex>>> for VectorIndexes

fn from(indexes: BTreeMap<FieldName, Box<dyn VectorIndex>>) -> Self

Converts to this type from the input type.

impl<Q: Ord + ?Sized> Index<&Q> for VectorIndexes

where FieldName: Borrow<Q>,

type Output = dyn VectorIndex

The returned type after indexing.

fn index(&self, field: &Q) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a VectorIndexes

type Item = (&'a String, &'a (dyn VectorIndex + 'static))

The type of the elements being iterated over.

type IntoIter = VectorIndexesIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl VectorIndexSource for VectorIndexes

fn visit( &self, visitor: &mut dyn FnMut(&str, &dyn VectorIndex) -> StorageBackendResult<()>, ) -> StorageBackendResult<()>

fn retained_collection(&self) -> StorageBackendResult<Option<VectorIndexes>>

An immutable collection may share its original allocation owner. Implementations must never capture or clone a live collection here.