shorterdb/
lib.rs

1//! # ShorterDB
2//!
3//! ShorterDB is a simple key-value store built using SkipLists and a De-LSM architecture.
4//! It can be used as an embedded database or as a gRPC-enabled server.
5//!
6//! ## Features
7//! - Embedded database with `ShorterDB`.
8//! - gRPC server for remote database access.
9//! - REPL for interactive usage.
10//!
11//! ## Usage
12//!
13//! Add `ShorterDB` to your `Cargo.toml`:
14//! ```toml
15//! shorterdb = "0.1.0"
16//! ```
17//!
18//! ### Embedded Database
19//! ```rust
20//! use shorterdb::kv::db::ShorterDB;
21//! use std::path::Path;
22//!
23//! let mut db = ShorterDB::new(Path::new("./test_db")).unwrap();
24//! db.set(b"key1", b"value1").unwrap();
25//! let value = db.get(b"key1").unwrap();
26//! assert_eq!(value, Some(b"value1".to_vec()));
27//! ```
28
29pub mod errors;
30pub mod kv;
31
32pub use kv::db::ShorterDB;