Struct flechasdb::db::build::proto::DatabaseSerialize

pub struct DatabaseSerialize<'a, T, VS>where
    VS: VectorSet<T>,{ /* private fields */ }

Serializable form of Database.

Methods from Deref<Target = Database<T, VS>>

pub fn num_vectors(&self) -> usize

Returns the number of vectors in the database.

pub fn vector_size(&self) -> usize

Returns the vector size.

pub fn num_partitions(&self) -> usize

Returns the number of partitions.

pub fn num_divisions(&self) -> usize

Returns the number of subvector divisions.

pub fn subvector_size(&self) -> usize

Returns the size of a subvector.

pub fn num_clusters(&self) -> usize

Returns the number of clusters.

pub fn vector_ids(&self) -> impl Iterator<Item = &Uuid>

Returns an iterator of vector IDs.

pub fn partitions(&self) -> PartitionIter<'_, T, VS>

Returns an iterator of partitions.

pub fn get_attribute<K>( &self, id: &Uuid, key: &K ) -> Result<Option<&AttributeValue>, Error>where String: Borrow<K>, K: Hash + Eq + ?Sized,

Returns the attribute value of a given vector.

Fails if no vector is associated with id.

pub fn query<V>( &self, v: &V, k: NonZeroUsize, nprobe: NonZeroUsize ) -> Result<Vec<QueryResult<T>>, Error>where V: AsSlice<T> + ?Sized,

Queries k-nearest neighbors (k-NN) of a given vector.

pub fn query_with_events<V, EventHandler>( &self, v: &V, k: NonZeroUsize, nprobe: NonZeroUsize, event: EventHandler ) -> Result<Vec<QueryResult<T>>, Error>where V: AsSlice<T> + ?Sized, EventHandler: FnMut(QueryEvent),

Queries k-nearest neighbors (k-NN) of a given vector.

Trait Implementations

impl<'a, T, VS> Deref for DatabaseSerialize<'a, T, VS>where VS: VectorSet<T>,

type Target = Database<T, VS>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, VS> Serialize<Database> for DatabaseSerialize<'a, f32, VS>where VS: VectorSet<f32>,

fn serialize(&self) -> Result<ProtosDatabase, Error>

Serializes as a message.