Skip to main content

Crate rvf_runtime

Crate rvf_runtime 

Source
Expand description

RuVector Format runtime — the main user-facing API.

This crate provides RvfStore, the primary interface for creating, opening, querying, and managing RVF vector stores. It ties together the segment model, manifest system, HNSW indexing, quantization, and compaction into a single cohesive runtime.

§Architecture

  • Append-only writes: All mutations append new segments; no in-place edits.
  • Progressive boot: Readers see results before the full file is loaded.
  • Single-writer / multi-reader: Advisory lock file enforces exclusivity.
  • Background compaction: Dead space is reclaimed without blocking queries.

Re-exports§

pub use cow::CowEngine;
pub use cow::CowStats;
pub use cow::WitnessEvent;
pub use cow_compact::CowCompactor;
pub use cow_map::CowMap;
pub use filter::FilterExpr;
pub use membership::MembershipFilter;
pub use options::CompactionResult;
pub use options::DeleteResult;
pub use options::IngestResult;
pub use options::MetadataEntry;
pub use options::MetadataValue;
pub use options::QueryOptions;
pub use options::RvfOptions;
pub use options::SearchResult;
pub use status::StoreStatus;
pub use store::RvfStore;

Modules§

compaction
Background compaction for dead space reclamation.
cow
COW read/write engine for vector-addressed clusters.
cow_compact
COW-aware compaction engine.
cow_map
COW cluster map for vector-addressed cluster resolution.
deletion
Logical deletion: soft-delete via JOURNAL_SEG tombstones.
filter
Filter expression evaluation for metadata-based vector filtering.
locking
Writer lock management for single-writer / multi-reader concurrency.
membership
Membership filter for shared HNSW index traversal.
options
Configuration types for the RVF runtime.
read_path
Progressive read logic for the RVF runtime.
status
Store status reporting.
store
Main RvfStore API — the primary user-facing interface.
write_path
Append-only write logic for the RVF runtime.