shodh-redb 0.3.0

Multi-modal embedded database - vectors, blobs, TTL, merge operators, and causal tracking built on ACID B-trees
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

// Originally from bf-tree (MIT, Microsoft Research). See LICENSE-MIT-BFTREE.
// Forked with no_std support by Roshera.
//
// # no_std requirements
// - Global allocator (`#[global_allocator]`) that supports 4096-byte alignment.
// - Multi-core target or RTOS with preemptive scheduling (spin-wait deadlocks
//   on single-core without preemption).

// Edition 2024 makes unsafe_op_in_unsafe_fn deny-by-default. The vendored
// bf-tree code has not been audited for this yet -- allow for now.
#![allow(unsafe_op_in_unsafe_fn)]
#![allow(unused_imports)]
// Pre-existing MSR bf-tree lint issues -- allow in forked code to avoid churn.
// The vendored code was written against bf-tree's own lint config; suppress
// shodh-redb's stricter deny(clippy::all, clippy::pedantic) for this module.
#![allow(clippy::all, clippy::pedantic, clippy::disallowed_methods, dead_code)]

pub mod circular_buffer;
mod config;
mod error;
mod fs;
mod nodes;

#[cfg(feature = "std")]
mod wal;

#[cfg(any(
    feature = "metrics",
    feature = "metrics-rt",
    feature = "metrics-rt-debug-all",
    feature = "metrics-rt-debug-timer"
))]
pub mod metric;

mod mini_page_op;
mod range_scan;
mod storage;
pub(crate) mod sync;
#[cfg(all(test, feature = "std", not(feature = "shuttle")))]
mod tests;

#[cfg(feature = "std")]
mod snapshot;
mod tree;
mod utils;

#[cfg(feature = "std")]
pub use config::WalConfig;
pub use config::{Config, StorageBackend};
pub use error::{BfTreeError, ConfigError, IoErrorKind};
pub use nodes::leaf_node::LeafReadResult;
pub use range_scan::{ScanIter, ScanReturnField};
pub use tree::{BfTree, LeafInsertResult, ScanIterError};
#[cfg(feature = "std")]
pub use wal::WalReader;

// These macros are used throughout the bf_tree submodules. They must be
// #[macro_export] so they're visible across file boundaries, but we hide
// them from the public API with #[doc(hidden)].

#[doc(hidden)]
#[macro_export]
macro_rules! info {
    ($($arg:tt)*) => {
        #[cfg(all(feature = "tracing", debug_assertions))]
        {
            tracing::info!($($arg)*);
        }

        #[cfg(not(all(feature = "tracing", debug_assertions)))]
        {
        }
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! counter {
    ($event:ident) => {
        #[cfg(feature = "metrics-rt")]
        {
            $crate::bf_tree::metric::get_tls_recorder()
                .increment_counter($crate::bf_tree::metric::Counter::$event, 1);
        }
    };
    ($event:ident, $value:literal) => {
        #[cfg(feature = "metrics-rt")]
        {
            $crate::bf_tree::metric::get_tls_recorder()
                .increment_counter($crate::bf_tree::metric::Counter::$event, $value);
        }
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! histogram {
    ($event:ident, $value:expr) => {
        #[cfg(feature = "metrics-rt")]
        {
            $crate::bf_tree::metric::get_tls_recorder()
                .hit_histogram($crate::bf_tree::metric::Histogram::$event, $value);
        }
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! timer {
    ($event:expr) => {
        let _timer_guard = if cfg!(feature = "metrics-rt") {
            Some($crate::bf_tree::metric::get_tls_recorder().timer_guard($event))
        } else {
            None
        };
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! check_parent {
    ($self:ident, $node:expr, $parent:expr) => {
        if let Some(p) = &$parent {
            p.check_version()?;
        } else if $node != $self.get_root_page().0 {
            return Err(TreeError::Locked);
        }
    };
}