rvf_runtime/lib.rs
1//! RuVector Format runtime — the main user-facing API.
2//!
3//! This crate provides [`RvfStore`], the primary interface for creating,
4//! opening, querying, and managing RVF vector stores. It ties together
5//! the segment model, manifest system, HNSW indexing, quantization, and
6//! compaction into a single cohesive runtime.
7//!
8//! # Architecture
9//!
10//! - **Append-only writes**: All mutations append new segments; no in-place edits.
11//! - **Progressive boot**: Readers see results before the full file is loaded.
12//! - **Single-writer / multi-reader**: Advisory lock file enforces exclusivity.
13//! - **Background compaction**: Dead space is reclaimed without blocking queries.
14
15pub mod compaction;
16pub mod cow;
17pub mod cow_compact;
18pub mod cow_map;
19pub mod deletion;
20pub mod filter;
21pub mod locking;
22pub mod membership;
23pub mod options;
24pub mod read_path;
25pub mod status;
26pub mod store;
27pub mod write_path;
28
29pub use cow::{CowEngine, CowStats, WitnessEvent};
30pub use cow_compact::CowCompactor;
31pub use cow_map::CowMap;
32pub use filter::FilterExpr;
33pub use membership::MembershipFilter;
34pub use options::{
35 CompactionResult, DeleteResult, IngestResult, MetadataEntry, MetadataValue, QueryOptions,
36 RvfOptions, SearchResult,
37};
38pub use status::StoreStatus;
39pub use store::RvfStore;