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 adversarial::adaptive_n_probe;pub use adversarial::centroid_distance_cv;pub use adversarial::combined_effective_n_probe;pub use adversarial::effective_n_probe_with_drift;pub use adversarial::is_degenerate_distribution;pub use adversarial::DEGENERATE_CV_THRESHOLD;pub use cow::CowEngine;pub use cow::CowStats;pub use cow::WitnessEvent;pub use cow_compact::CowCompactor;pub use cow_map::CowMap;pub use dos::BudgetTokenBucket;pub use dos::NegativeCache;pub use dos::ProofOfWork;pub use dos::QuerySignature;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::QualityEnvelope;pub use options::RvfOptions;pub use options::SearchResult;pub use options::WitnessConfig;pub use compress::compress;pub use compress::decompress;pub use compress::CompressError;pub use qr_seed::BootstrapProgress;pub use qr_seed::DownloadManifest;pub use qr_seed::ParsedSeed;pub use qr_seed::SeedBuilder;pub use qr_seed::SeedError;pub use qr_seed::make_host_entry;pub use seed_crypto::seed_content_hash;pub use seed_crypto::layer_content_hash;pub use seed_crypto::full_content_hash;pub use seed_crypto::sign_seed;pub use seed_crypto::verify_seed;pub use seed_crypto::verify_layer;pub use seed_crypto::SIG_ALGO_HMAC_SHA256;pub use safety_net::selective_safety_net_scan;pub use safety_net::should_activate_safety_net;pub use safety_net::Candidate;pub use safety_net::SafetyNetResult;pub use status::StoreStatus;pub use store::RvfStore;pub use witness::GovernancePolicy;pub use witness::ParsedWitness;pub use witness::ScorecardBuilder;pub use witness::WitnessBuilder;pub use witness::WitnessError;pub use agi_container::AgiContainerBuilder;pub use agi_container::ParsedAgiManifest;
Modules§
- adversarial
- Adversarial distribution detection and adaptive n_probe for ADR-033 §2.
- agi_
authority - Authority and resource budget enforcement runtime for AGI containers (ADR-036).
- agi_
coherence - Coherence monitoring and container validation pipeline (ADR-036).
- agi_
container - AGI Cognitive Container builder and validator (ADR-036).
- compaction
- Background compaction for dead space reclamation.
- compress
- Zero-dependency LZ77 compression for QR seed microkernels.
- 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.
- dos
- DoS hardening for ADR-033 §3.3.1.
- ffi
- C FFI for App Clip / mobile integration.
- 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.
- qr_seed
- QR Cognitive Seed generator and parser for ADR-034.
- read_
path - Progressive read logic for the RVF runtime.
- safety_
net - Selective safety net scan for ADR-033 §3.3.
- seed_
crypto - Cryptographic operations for QR seed signing and verification.
- status
- Store status reporting.
- store
- Main RvfStore API — the primary user-facing interface.
- witness
- Witness bundle builder, parser, scorecard aggregator, and governance enforcement for ADR-035 capability reports.
- write_
path - Append-only write logic for the RVF runtime.