Skip to main content

ScopedIndex

Struct ScopedIndex 

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

Manages multiple VectorIndex instances — one per scope (global, each project) plus a combined “all” index. Every memory exists in exactly two indexes: its scope-specific index + the “all” index.

ScopedIndex is Send + Sync because all inner state is protected by RwLock / Mutex.

Implementations§

Source§

impl ScopedIndex

Source

pub fn new(dimensions: usize) -> Result<Self, MemoryError>

Create a new ScopedIndex with empty global + all indexes.

Source

pub fn add( &self, scope: &Scope, vector: &[f32], qualified_name: String, ) -> Result<u64, MemoryError>

Insert vector into both the scope-specific index and the all-index.

Handles upserts: if qualified_name already exists in either index, the old entry is removed after the new one is successfully inserted.

Returns the key assigned in the all-index.

Source

pub fn remove( &self, scope: &Scope, qualified_name: &str, ) -> Result<(), MemoryError>

Remove a memory by qualified name from both the scope-specific index and the all-index.

Both removals are best-effort: an error in one does not prevent the other from running. Returns Ok(()) regardless of individual failures.

Source

pub fn search( &self, filter: &ScopeFilter, query: &[f32], limit: usize, ) -> Result<Vec<(u64, String, f32)>, MemoryError>

Search for the nearest neighbours of query, routing to the correct indexes based on filter.

filterIndexes searchedMerge strategy
GlobalOnlyglobalDirect top-k
ProjectAndGlobal(p)global + projects/pMerge by distance, top-k
Allall combined indexDirect top-k
Source

pub fn find_key_by_name(&self, qualified_name: &str) -> Option<u64>

Find the key for a given qualified name in the all-index (not scope-specific).

This is the canonical lookup — the all-index contains every memory regardless of scope.

Source

pub fn grow_if_needed(&self, additional: usize) -> Result<(), MemoryError>

Grow all indexes to accommodate additional more vectors.

Reserved for future batch-insert operations; no production callers currently exist.

Source

pub fn save(&self, dir: &Path) -> Result<(), MemoryError>

Persist all indexes to subdirectories under dir.

Layout:

dir/
  all/index.usearch  (+ .keys.json)
  global/index.usearch
  projects/foo/index.usearch
Source

pub fn load(dir: &Path, dimensions: usize) -> Result<Self, MemoryError>

Load all indexes from subdirectories under dir.

Missing subdirectories are treated as empty — those scopes will be rebuilt incrementally on next use.

Source

pub fn commit_sha(&self) -> Option<String>

Read the commit SHA from the all-index metadata.

Source

pub fn set_commit_sha(&self, sha: Option<&str>)

Set the commit SHA on all sub-indexes.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,