pub struct VectorIndexEntry {
pub index: Arc<VectorIndex>,
pub name: Option<DbString>,
}Expand description
Registered built-in vector-index metadata.
Fields§
§index: Arc<VectorIndex>Index data for the (label, property) registration.
name: Option<DbString>Optional explicit catalog name. None means the name is derived at render time.
Implementations§
Source§impl VectorIndexEntry
impl VectorIndexEntry
Sourcepub fn new(index: VectorIndex, name: Option<DbString>) -> Self
pub fn new(index: VectorIndex, name: Option<DbString>) -> Self
Construct a vector index entry from the built index and optional name.
Sourcepub fn kind(&self) -> VectorIndexKind
pub fn kind(&self) -> VectorIndexKind
Return the registered vector index kind.
Sourcepub fn hnsw_config(&self) -> Option<HnswIndexConfig>
pub fn hnsw_config(&self) -> Option<HnswIndexConfig>
Return the registered HNSW construction config, if this is an HNSW index.
Sourcepub fn ivf_config(&self) -> Option<IvfIndexConfig>
pub fn ivf_config(&self) -> Option<IvfIndexConfig>
Return the registered IVF construction config, if this is a configured IVF index.
Sourcepub fn memory_usage(&self) -> VectorIndexMemoryUsage
pub fn memory_usage(&self) -> VectorIndexMemoryUsage
Return an estimated memory usage snapshot for this vector index.
Trait Implementations§
Source§impl Clone for VectorIndexEntry
impl Clone for VectorIndexEntry
Source§fn clone(&self) -> VectorIndexEntry
fn clone(&self) -> VectorIndexEntry
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for VectorIndexEntry
impl RefUnwindSafe for VectorIndexEntry
impl Send for VectorIndexEntry
impl Sync for VectorIndexEntry
impl Unpin for VectorIndexEntry
impl UnsafeUnpin for VectorIndexEntry
impl UnwindSafe for VectorIndexEntry
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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>
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 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>
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 moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Returns whether the given value has been niched. Read more
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.