Skip to main content

UpdatableVGraph

Struct UpdatableVGraph 

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

A mapped base plus a mutable graph delta, with atomic durable batches. insert, delete, and replace publish immediately; commit makes the batch durable. Only one process may open a directory, while any number of threads may search it.

Implementations§

Source§

impl UpdatableVGraph

Source

pub fn create( path: &Path, data: &[f32], dim: usize, params: &BuildParams, ) -> Result<Self, UpdateError>

Creates a new directory from row-major vectors with ids 0..n.

Source

pub fn create_from_graph( path: &Path, graph: &Graph, vertex: &VGraph, ) -> Result<Self, UpdateError>

Saves a graph and its matching vertex encoding without rebuilding the graph.

Source

pub fn open(path: &Path) -> Result<Self, UpdateError>

Opens and replays committed batches; truncates only an incomplete final frame.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn dim(&self) -> usize

Source

pub fn insert(&self, id: u32, vector: &[f32]) -> Result<(), UpdateError>

Stages a new id in the current batch.

Source

pub fn delete(&self, id: u32) -> Result<(), UpdateError>

Stages deletion of an existing id.

Source

pub fn replace(&self, id: u32, vector: &[f32]) -> Result<(), UpdateError>

Atomically invalidates the previous vector and inserts the replacement.

Source

pub fn batch_capacity(&self) -> usize

Most operations one batch can stage before commit for vectors of this dimension.

Source

pub fn insert_batch( &self, ids: &[u32], vectors: &[f32], ) -> Result<(), UpdateError>

Stages new ids for row-major vectors, all or none, linking them into the delta in parallel. Up to batch_capacity operations fit in one batch.

Source

pub fn commit(&self) -> Result<(), UpdateError>

Appends the whole pending batch and completes its durable sync.

Source

pub fn search( &self, query: &[f32], k: usize, params: VSearchParams, ) -> Result<Vec<u32>, UpdateError>

Searches a consistent in-memory view. k is clamped to the live count.

Source

pub fn search_into( &self, query: &[f32], k: usize, params: VSearchParams, out: &mut Vec<u32>, ) -> Result<(), UpdateError>

Searches with a reusable result buffer, avoiding allocation on clean-base queries.

Source

pub fn needs_consolidation( &self, policy: ConsolidationPolicy, ) -> Result<bool, UpdateError>

Source

pub fn consolidate(&self) -> Result<(), UpdateError>

Commits pending work and publishes a new immutable generation while readers run.

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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