pub struct MetadataIndex { /* private fields */ }Expand description
Key-addressed metadata used to filter owned or memory-mapped indexes.
Implementations§
Source§impl MetadataIndex
impl MetadataIndex
pub const fn new() -> Self
pub fn insert(&mut self, key: u64, metadata: Metadata) -> Option<Metadata>
pub fn remove(&mut self, key: u64) -> Option<Metadata>
pub fn get(&self, key: u64) -> Option<&Metadata>
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
pub fn iter(&self) -> impl ExactSizeIterator<Item = (u64, &Metadata)>
pub fn matches(&self, key: u64, filter: &MetadataFilter) -> bool
pub fn matching_keys(&self, filter: &MetadataFilter) -> BTreeSet<u64>
Source§impl MetadataIndex
impl MetadataIndex
Sourcepub fn search(
&self,
index: &VectorIndex,
query: &[f32],
count: usize,
filter: &MetadataFilter,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search( &self, index: &VectorIndex, query: &[f32], count: usize, filter: &MetadataFilter, ) -> Result<Vec<SearchHit>, SearchError>
Searches an owned index and guarantees enough filtered hits through the index’s exact fallback.
§Errors
Returns a typed query or allocation error.
Sourcepub fn search_mapped(
&self,
index: &MappedVectorIndex,
query: &[f32],
count: usize,
filter: &MetadataFilter,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search_mapped( &self, index: &MappedVectorIndex, query: &[f32], count: usize, filter: &MetadataFilter, ) -> Result<Vec<SearchHit>, SearchError>
Searches a memory-mapped index with the same filter semantics.
§Errors
Returns a typed query or allocation error.
Trait Implementations§
Source§impl Clone for MetadataIndex
impl Clone for MetadataIndex
Source§fn clone(&self) -> MetadataIndex
fn clone(&self) -> MetadataIndex
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for MetadataIndex
impl Debug for MetadataIndex
Source§impl Default for MetadataIndex
impl Default for MetadataIndex
Source§fn default() -> MetadataIndex
fn default() -> MetadataIndex
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for MetadataIndex
impl RefUnwindSafe for MetadataIndex
impl Send for MetadataIndex
impl Sync for MetadataIndex
impl Unpin for MetadataIndex
impl UnsafeUnpin for MetadataIndex
impl UnwindSafe for MetadataIndex
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more