vsdb_core 13.4.6

A std-collection-like database
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

//! # vsdb_core
//!
//! `vsdb_core` provides the low-level building blocks for `vsdb`, including the
//! storage layer, raw data structures, and common utilities. It is not
//! typically used directly by end-users, but forms the foundation of the `vsdb`
//! ecosystem.
//!
//! ## Storage backend
//!
//! The storage engine is MMDB, a pure-Rust LSM-Tree engine.

#![deny(warnings)]
#![recursion_limit = "512"]

/// Manages the storage layer, raw data types, and shared utilities.
///
/// This module provides the storage engine along with fundamental
/// types such as `RawKey`, `RawValue`, and environment management functions.
pub mod common;

/// Contains raw, untyped data structures.
///
/// This module provides `MapxRaw`, a basic, high-performance key-value map that
/// operates on raw bytes. It serves as the foundation for the typed, user-facing
/// collections in the `vsdb` crate.
pub mod basic;

/// A raw, high-performance, disk-backed key-value map.
pub use basic::mapx_raw::MapxRaw;

/// Commonly used items, re-exported for convenience.
///
/// This includes data size constants (KB, MB, GB), a null terminator constant (`NULL`),
/// raw data types (`RawBytes`, `RawKey`, `RawValue`), and functions for managing
/// the database environment (e.g., `vsdb_flush`, `vsdb_set_base_dir`).
pub use common::{
    BatchTrait, GB, KB, MB, NULL, RawBytes, RawKey, RawValue, vsdb_flush,
    vsdb_get_base_dir, vsdb_get_custom_dir, vsdb_get_meta_dir, vsdb_get_system_dir,
    vsdb_meta_path, vsdb_set_base_dir,
};