emdb 0.3.0

A lightweight, high-performance embedded database for Rust.
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

// Copyright 2026 James Gober. Licensed under Apache-2.0.

//! Database builder.

use std::path::PathBuf;

#[cfg(feature = "ttl")]
use std::time::Duration;

use crate::storage::FlushPolicy;
use crate::Emdb;
use crate::Result;

/// Builder for constructing an in-memory [`Emdb`] instance.
#[derive(Debug, Clone, Default)]
pub struct EmdbBuilder {
    #[cfg(feature = "ttl")]
    pub(crate) default_ttl: Option<Duration>,
    pub(crate) path: Option<PathBuf>,
    pub(crate) flush_policy: FlushPolicy,
}

impl EmdbBuilder {
    /// Create a new builder.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the global default TTL for inserted records.
    #[cfg(feature = "ttl")]
    #[must_use]
    pub fn default_ttl(mut self, ttl: Duration) -> Self {
        self.default_ttl = Some(ttl);
        self
    }

    /// Set a file path for persistent storage.
    #[must_use]
    pub fn path(mut self, path: impl Into<PathBuf>) -> Self {
        self.path = Some(path.into());
        self
    }

    /// Set flush durability policy.
    #[must_use]
    pub fn flush_policy(mut self, policy: FlushPolicy) -> Self {
        self.flush_policy = policy;
        self
    }

    /// Build an [`Emdb`] instance from the configured options.
    ///
    /// # Errors
    ///
    /// Returns an error when configuration is invalid (for example
    /// `FlushPolicy::EveryN(0)`) or storage initialization fails.
    pub fn build(self) -> Result<Emdb> {
        Emdb::from_builder(self)
    }
}

#[cfg(test)]
mod tests {
    use super::EmdbBuilder;
    use crate::FlushPolicy;

    #[test]
    fn test_build_returns_empty_database() {
        let db = EmdbBuilder::new().build();
        assert!(db.is_ok());
        let db = match db {
            Ok(db) => db,
            Err(err) => panic!("build should succeed: {err}"),
        };
        assert!(db.is_empty());
    }

    #[test]
    fn test_default_builder_builds_database() {
        let db = EmdbBuilder::default().build();
        assert!(db.is_ok());
        let db = match db {
            Ok(db) => db,
            Err(err) => panic!("build should succeed: {err}"),
        };
        assert_eq!(db.len(), 0);
    }

    #[cfg(feature = "ttl")]
    #[test]
    fn test_default_ttl_builder_method_is_usable() {
        use std::time::Duration;

        let db = EmdbBuilder::new()
            .default_ttl(Duration::from_secs(1))
            .build();
        assert!(db.is_ok());
        let db = match db {
            Ok(db) => db,
            Err(err) => panic!("build should succeed: {err}"),
        };
        assert!(db.is_empty());
    }

    #[test]
    fn test_flush_policy_every_n_zero_errors() {
        let db = EmdbBuilder::new()
            .flush_policy(FlushPolicy::EveryN(0))
            .build();
        assert!(db.is_err());
    }
}