Skip to content

Add crate-level re-exports to minikv_core lib #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ekkolon merged 1 commit into from
Feb 27, 2026
Merged

Add crate-level re-exports to minikv_core lib #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions minikv-core/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,42 @@
//! `minikv_core`
//!
//! Core library for a deterministic, replicated object metadata layer.
//!
//! This crate provides the hashing, volume selection, record encoding,
//! replication, rebuild, and rebalance logic required to maintain
//! a consistent mapping between object keys and storage volumes.
//!
//! The system is designed around the following principles:
//!
//! - Deterministic key → path mapping (`key_to_path`)
//! - Deterministic key → replica selection (`key_to_volume`)
//! - Explicit, auditable record encoding (`Record`)
//! - Metadata recovery from storage volumes (`rebuild_all`)
//! - Convergence to ideal replica placement (`rebalance_all`)
//!
//! The crate does not implement an HTTP server. It focuses strictly on:
//!
//! - Metadata representation and storage abstraction (`MetadataStore`)
//! - Volume interaction primitives (`remote_get`, `remote_put`, etc.)
//! - Replica placement and reconciliation logic
//!
//! All replica selection and ordering is deterministic. Any change to
//! hashing or volume selection logic will change placement and is therefore
//! considered a breaking behavioural change.
//!
//! # High-Level Architecture
//!
//! - `hashing` — Key-to-path and volume scoring primitives.
//! - `volumes` — Replica selection and rebalance detection.
//! - `record` — On-disk metadata encoding format.
//! - `storage` — Metadata storage abstraction.
//! - `replication` — HTTP primitives for volume interaction.
//! - `rebuild` — Metadata reconstruction from volumes.
//! - `rebalance` — Migration to ideal replica sets.
//! - `locking` — Per-key concurrency control.
//!
//! This crate is intended to be embedded in a higher-level service.

pub mod error;
pub mod hashing;
pub mod locking;
Expand All @@ -10,3 +49,12 @@ pub mod storage;
pub mod volumes;

pub use error::Error;
pub use hashing::{key_to_path, volume_score};
pub use locking::{KeyGuard, KeyLock};
pub use rebalance::{rebalance_all, rebalance_key};
pub use rebuild::{AutoindexEntry, rebuild_all};
pub use record::{Deleted, Record};
pub use replication::{build_volume_client, remote_delete, remote_get, remote_head, remote_put};
pub use state::AppState;
pub use storage::{KeyValuePair, MetadataStore};
pub use volumes::{key_to_volume, needs_rebalance};
Loading