alopex-embedded 0.6.0

Embedded database interface for Alopex DB
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

//! Database configuration options for the embedded API.

use alopex_core::StorageMode;
use std::path::Path;

/// Options for configuring how a database instance is opened.
#[derive(Debug, Clone, Default)]
pub struct DatabaseOptions {
    /// Whether to use in-memory mode.
    memory_mode: bool,
    /// Optional memory limit for in-memory mode (bytes).
    memory_limit: Option<usize>,
}

impl DatabaseOptions {
    /// Returns disk-backed options (default).
    pub fn new() -> Self {
        Self::default()
    }

    /// Creates options configured for in-memory mode without a memory cap.
    pub fn in_memory() -> Self {
        Self {
            memory_mode: true,
            memory_limit: None,
        }
    }

    /// Sets an optional memory limit (bytes) and enables in-memory mode.
    pub fn with_memory_limit(mut self, bytes: usize) -> Self {
        self.memory_mode = true;
        self.memory_limit = Some(bytes);
        self
    }

    /// Returns true when in-memory mode is enabled.
    pub fn memory_mode(&self) -> bool {
        self.memory_mode
    }

    /// Returns the optional memory limit when configured.
    pub fn memory_limit(&self) -> Option<usize> {
        self.memory_limit
    }

    /// Convert the options to a core StorageMode.
    pub(crate) fn to_storage_mode(&self, path: Option<&Path>) -> StorageMode {
        if self.memory_mode {
            StorageMode::Memory {
                max_size: self.memory_limit,
            }
        } else {
            let disk_path = path.expect("disk mode requires a path");
            StorageMode::Disk {
                path: crate::disk_data_dir_path(disk_path),
                config: None,
            }
        }
    }
}