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>
impl<T: Serialize + DeserializeOwned> SealedRingDb<T>
Sourcepub fn query(&self, q: &RingQuery<'_>) -> Result<QueryResult, RingDbError>
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.
Sourcepub fn query_range(
&self,
q: &RangeQuery<'_>,
) -> Result<QueryResult, RingDbError>
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].
Sourcepub fn query_disk(&self, q: &DiskQuery<'_>) -> Result<QueryResult, RingDbError>
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).
Sourcepub fn fetch_payload(&self, id: u32) -> Result<T, RingDbError>
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.
Sourcepub fn fetch_payloads(&self, ids: &[u32]) -> Result<Vec<T>, RingDbError>
pub fn fetch_payloads(&self, ids: &[u32]) -> Result<Vec<T>, RingDbError>
Fetch payloads for a slice of vector IDs, in order.
Sourcepub fn backend_name(&self) -> &str
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> 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
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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