Skip to main content

MetadataIndex

Struct MetadataIndex 

Source
pub struct MetadataIndex { /* private fields */ }
Expand description

Key-addressed metadata used to filter owned or memory-mapped indexes.

Implementations§

Source§

impl MetadataIndex

Source

pub const fn new() -> Self

Source

pub fn insert(&mut self, key: u64, metadata: Metadata) -> Option<Metadata>

Source

pub fn remove(&mut self, key: u64) -> Option<Metadata>

Source

pub fn get(&self, key: u64) -> Option<&Metadata>

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn iter(&self) -> impl ExactSizeIterator<Item = (u64, &Metadata)>

Source

pub fn matches(&self, key: u64, filter: &MetadataFilter) -> bool

Source

pub fn matching_keys(&self, filter: &MetadataFilter) -> BTreeSet<u64>

Source§

impl MetadataIndex

Source

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.

Source

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

Source§

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)

Performs copy-assignment from source. Read more
Source§

impl Debug for MetadataIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MetadataIndex

Source§

fn default() -> MetadataIndex

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.