pub struct MappedVectorIndex { /* private fields */ }Expand description
Read-only HNSW index backed directly by a versioned memory-mapped snapshot.
Implementations§
Source§impl MappedVectorIndex
impl MappedVectorIndex
Sourcepub fn open(path: impl AsRef<Path>) -> Result<Self, SearchError>
pub fn open(path: impl AsRef<Path>) -> Result<Self, SearchError>
Opens and fully validates a read-only memory-mapped snapshot.
§Errors
Returns a typed storage, version, integrity, or config error.
Sourcepub fn open_with_validation(
path: impl AsRef<Path>,
validation: SnapshotValidation,
) -> Result<Self, SearchError>
pub fn open_with_validation( path: impl AsRef<Path>, validation: SnapshotValidation, ) -> Result<Self, SearchError>
Opens a read-only snapshot with an explicit validation policy.
§Errors
Returns a typed storage, version, integrity, or config error.
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
pub fn dimensions(&self) -> usize
pub fn config(&self) -> &IndexConfig
Sourcepub fn mapped_bytes(&self) -> usize
pub fn mapped_bytes(&self) -> usize
Returns the mapped file length. Query scratch and the small graph-layout table are excluded.
Sourcepub fn keys(&self) -> impl ExactSizeIterator<Item = u64> + '_
pub fn keys(&self) -> impl ExactSizeIterator<Item = u64> + '_
Iterates stable keys in ascending order.
Source§impl MappedVectorIndex
impl MappedVectorIndex
Sourcepub fn search_batch(
&self,
queries: &[&[f32]],
count: usize,
) -> Result<Vec<Vec<SearchHit>>, SearchError>
pub fn search_batch( &self, queries: &[&[f32]], count: usize, ) -> Result<Vec<Vec<SearchHit>>, SearchError>
Searches mapped queries using bounded standard-library workers.
§Errors
Returns the first query error in input order or a worker-panic error.
Sourcepub fn search_batch_with_policy(
&self,
queries: &[&[f32]],
count: usize,
policy: SearchPolicy,
) -> Result<Vec<Vec<SearchHit>>, SearchError>
pub fn search_batch_with_policy( &self, queries: &[&[f32]], count: usize, policy: SearchPolicy, ) -> Result<Vec<Vec<SearchHit>>, SearchError>
Searches mapped queries with a shared per-query recall policy.
§Errors
Returns the first query error in input order or a worker-panic error.
Source§impl MappedVectorIndex
impl MappedVectorIndex
Sourcepub fn search_exact(
&self,
query: &[f32],
count: usize,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search_exact( &self, query: &[f32], count: usize, ) -> Result<Vec<SearchHit>, SearchError>
Returns exact top-K hits directly from mapped vectors.
§Errors
Returns a typed error for an invalid query.
Sourcepub fn search_exact_filtered<F>(
&self,
query: &[f32],
count: usize,
filter: F,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search_exact_filtered<F>( &self, query: &[f32], count: usize, filter: F, ) -> Result<Vec<SearchHit>, SearchError>
Returns exact top-K mapped hits accepted by filter.
§Errors
Returns a typed error for an invalid query.
Sourcepub fn search_filtered<F>(
&self,
query: &[f32],
count: usize,
filter: F,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search_filtered<F>( &self, query: &[f32], count: usize, filter: F, ) -> Result<Vec<SearchHit>, SearchError>
Searches mapped HNSW candidates accepted by filter, with an exact
fallback for selective filters.
§Errors
Returns a typed query or allocation error.
Sourcepub fn search_filtered_with_policy<F>(
&self,
query: &[f32],
count: usize,
filter: F,
policy: FilterSearchPolicy,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search_filtered_with_policy<F>( &self, query: &[f32], count: usize, filter: F, policy: FilterSearchPolicy, ) -> Result<Vec<SearchHit>, SearchError>
Searches a mapped graph with the predicate applied during traversal.
§Errors
Returns a typed query or allocation error.
Source§impl MappedVectorIndex
impl MappedVectorIndex
Sourcepub fn to_owned(&self) -> Result<VectorIndex, SearchError>
pub fn to_owned(&self) -> Result<VectorIndex, SearchError>
Materializes the mapped index without rebuilding its graph.
§Errors
Returns an allocation, integrity, or config error.
Source§impl MappedVectorIndex
impl MappedVectorIndex
Sourcepub fn search(
&self,
query: &[f32],
count: usize,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search( &self, query: &[f32], count: usize, ) -> Result<Vec<SearchHit>, SearchError>
Returns approximate top-K hits ordered by exact distance and key.
§Errors
Returns a typed error for an invalid query or scratch allocation.
Sourcepub fn search_with_policy(
&self,
query: &[f32],
count: usize,
policy: SearchPolicy,
) -> Result<Vec<SearchHit>, SearchError>
pub fn search_with_policy( &self, query: &[f32], count: usize, policy: SearchPolicy, ) -> Result<Vec<SearchHit>, SearchError>
Returns approximate top-K hits with a per-query recall policy.
§Errors
Returns a typed error for an invalid policy, query, or scratch allocation.