kivis 0.5.1

Type-safe database schema generation for Rust with support for custom storage backends, automatic indexing, and layered cache architectures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! # Kivis Database
//!
//! A lightweight, type-safe database schema library for Rust with support for custom storage backends,
//! automatic indexing, and foreign key relationships.
//!
//! ## Features
//!
//! - **Type-safe schema generation**: Automatically derive database schemas from Rust structs
//! - **Generic storage backend support**: Work with any ordered key-value store
//! - **Automatic key generation and indexing**: Support for auto-increment keys and secondary indexes
//! - **Foreign key relationships**: Type-safe references between records
//! - **Layered cache architectures**: Compose multiple storage implementations
//!
//! ## Feature Flags
//!
//! - `std` (default): Enable standard library support (implies `alloc`)
//! - `alloc`: Enable `Vec` and `String` support without requiring the full standard library
//! - `atomic` (default): Enable atomic transaction support (requires `alloc`)
//! - `memory-storage` (default): Include in-memory storage implementation
//! - `heapless`: Enable `UnifierData` implementation for `heapless::Vec<u8, N>`, allowing fixed-capacity
//!   stack-allocated vectors for embedded environments
//!
//! ## Quick Start
//!
//! ```rust
//! use kivis::{Database, MemoryStorage, Record, manifest};
//!
//! #[derive(Record, serde::Serialize, serde::Deserialize, Debug)]
//! struct User {
//!     name: String,
//!     email: String,
//! }
//!
//! // Define the manifest for the database
//! manifest![MyDatabase: User];
//!
//! # fn main() -> Result<(), kivis::DatabaseError<kivis::MemoryStorage>> {
//! let mut db = Database::<MemoryStorage, MyDatabase>::new(MemoryStorage::new())?;
//! let user = User {
//!     name: "Alice".to_string(),
//!     email: "alice@example.com".to_string(),
//! };
//! let user_key = db.put(user)?;
//! # Ok(())
//! # }
//! ```

#![cfg_attr(not(feature = "std"), no_std)]
#![warn(clippy::pedantic)]
#![deny(clippy::unwrap_used)]
#![deny(clippy::expect_used)]

mod database;
mod errors;
mod impls;
mod intergrations;
mod traits;
mod transaction;
mod utils;
mod wrap;

pub use database::Database;
pub use kivis_derive::Record;
pub use paste::paste;
pub use traits::*;
pub use utils::*;

pub use crate::errors::{
    BufferOverflowError, BufferOverflowOr, DatabaseError, InternalDatabaseError,
};

#[cfg(feature = "atomic")]
// Database transaction is only usefull if atomic storage is enabled.
pub use transaction::{
    BufferOp, BufferOpsContainer, DatabaseTransaction, OpsIter, TransactionError,
};

#[cfg(feature = "sled")]
pub use intergrations::{PostcardUnifier, SledStorageError};