IndexRegistry

Struct IndexRegistry 

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

Thread-safe registry for managing multiple named indexes.

§Example

use rag_plusplus_core::index::{IndexRegistry, FlatIndex, IndexConfig};

let mut registry = IndexRegistry::new();

// Register indexes for different modalities
let text_index = FlatIndex::new(IndexConfig::new(768));
let code_index = FlatIndex::new(IndexConfig::new(512));

registry.register("text_embeddings", text_index)?;
registry.register("code_embeddings", code_index)?;

// Search specific index
let results = registry.search("text_embeddings", &query, 10)?;

// Search all indexes
let all_results = registry.search_all(&query, 10)?;

Implementations§

Source§

impl IndexRegistry

Source

pub fn new() -> Self

Create a new empty registry.

Source

pub fn with_capacity(capacity: usize) -> Self

Create registry with pre-allocated capacity.

Source

pub fn register<I: VectorIndex + 'static>( &mut self, name: impl Into<String>, index: I, ) -> Result<()>

Register a new index with the given name.

§Errors

Returns error if an index with the same name already exists.

Source

pub fn register_or_replace<I: VectorIndex + 'static>( &mut self, name: impl Into<String>, index: I, ) -> Option<Box<dyn VectorIndex>>

Register or replace an index.

Returns the previous index if one existed.

Source

pub fn get(&self, name: &str) -> Option<&dyn VectorIndex>

Get a reference to an index by name.

Source

pub fn remove(&mut self, name: &str) -> Option<Box<dyn VectorIndex>>

Remove an index by name.

Returns the removed index if it existed.

Source

pub fn contains(&self, name: &str) -> bool

Check if an index exists.

Source

pub fn list(&self) -> Vec<&str>

List all registered index names.

Source

pub fn info(&self) -> Vec<IndexInfo>

Get information about all registered indexes.

Source

pub fn len(&self) -> usize

Number of registered indexes.

Source

pub fn is_empty(&self) -> bool

Check if registry is empty.

Source

pub fn total_vectors(&self) -> usize

Total number of vectors across all indexes.

Source

pub fn total_memory(&self) -> usize

Total memory usage across all indexes.

Source

pub fn search( &self, name: &str, query: &[f32], k: usize, ) -> Result<Vec<SearchResult>>

Search a specific index by name.

§Errors

Returns error if index doesn’t exist or search fails.

Source

pub fn search_all(&self, query: &[f32], k: usize) -> Result<MultiIndexResults>

Search all indexes with the same query.

Note: This is a sequential search. For parallel search, use parallel_search_all.

§Errors

Returns error if any search fails.

Source

pub fn search_indexes( &self, names: &[&str], query: &[f32], k: usize, ) -> Result<MultiIndexResults>

Search multiple specific indexes.

§Arguments
  • names - Index names to search
  • query - Query vector
  • k - Number of results per index
§Errors

Returns error if any index doesn’t exist or search fails.

Source

pub fn add( &mut self, index_name: &str, id: String, vector: &[f32], ) -> Result<()>

Add a vector to a specific index.

§Errors

Returns error if index doesn’t exist or add fails.

Source

pub fn remove_vector(&mut self, index_name: &str, id: &str) -> Result<bool>

Remove a vector from a specific index.

§Errors

Returns error if index doesn’t exist.

Source

pub fn clear_all(&mut self)

Clear all vectors from all indexes.

Trait Implementations§

Source§

impl Debug for IndexRegistry

Source§

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

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

impl Default for IndexRegistry

Source§

fn default() -> IndexRegistry

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
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> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
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