Skip to main content

SealedRingDb

Struct SealedRingDb 

Source
pub struct SealedRingDb<T = ()> { /* private fields */ }
Expand description

Sealed (immutable) ring-query database.

Obtained by calling RingDb::build() or RingDb::load(). Vectors can no longer be inserted — only queries and payload fetches are allowed.

The hot side (vectors + norms) is owned by the compute backend. The cold side (payloads) lives in an anonymous mmap managed by [PayloadStore].

Implementations§

Source§

impl<T: Serialize + DeserializeOwned> SealedRingDb<T>

Source

pub fn query(&self, q: &RingQuery<'_>) -> Result<QueryResult, RingDbError>

Execute a ring query and return matching vector IDs.

The ring [d - lambda, d + lambda] is converted to [d_min, d_max] internally; negative lower bounds are clamped to 0.

Source

pub fn query_range( &self, q: &RangeQuery<'_>, ) -> Result<QueryResult, RingDbError>

Execute a range query and return matching vector IDs.

Returns all vectors whose Euclidean distance to the query lies in [d_min, d_max].

Source

pub fn query_disk(&self, q: &DiskQuery<'_>) -> Result<QueryResult, RingDbError>

Execute a disk query and return matching vector IDs.

Returns all vectors within Euclidean distance d_max of the query (i.e. the full ball of radius d_max, equivalent to d_min = 0).

Source

pub fn fetch_payload(&self, id: u32) -> Result<T, RingDbError>

Fetch the payload for a single vector ID.

Reads and deserializes from the cold mmap. Call this after query to retrieve metadata for the matching vectors.

Source

pub fn fetch_payloads(&self, ids: &[u32]) -> Result<Vec<T>, RingDbError>

Fetch payloads for a slice of vector IDs, in order.

Source

pub fn len(&self) -> usize

Number of vectors stored.

Source

pub fn is_empty(&self) -> bool

Returns true if the database contains no vectors.

Source

pub fn dims(&self) -> usize

Number of dimensions per vector.

Source

pub fn backend_name(&self) -> &str

Name of the backend currently in use.

Auto Trait Implementations§

§

impl<T> Freeze for SealedRingDb<T>

§

impl<T = ()> !RefUnwindSafe for SealedRingDb<T>

§

impl<T> Send for SealedRingDb<T>
where T: Send,

§

impl<T> Sync for SealedRingDb<T>
where T: Sync,

§

impl<T> Unpin for SealedRingDb<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for SealedRingDb<T>

§

impl<T = ()> !UnwindSafe for SealedRingDb<T>

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, 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, 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.