rotbl 0.2.10

Read Only Table
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

#[derive(Default)]
#[derive(Debug)]
#[derive(Clone)]
pub struct BlockCacheConfig {
    /// Max bytes to cache
    pub capacity: Option<usize>,
}

#[allow(clippy::identity_op)]
impl BlockCacheConfig {
    const DEFAULT_CAPACITY: usize = 1 * 1024 * 1024 * 1024;

    pub fn with_capacity(mut self, capacity: usize) -> Self {
        self.capacity = Some(capacity);
        self
    }

    pub fn capacity(&self) -> usize {
        self.capacity.unwrap_or(Self::DEFAULT_CAPACITY)
    }
}

#[derive(Default)]
#[derive(Debug)]
#[derive(Clone)]
pub struct BlockConfig {
    /// Max item per block
    pub max_items: Option<usize>,
}

impl BlockConfig {
    const DEFAULT_MAX_ITEM: usize = 8 * 1024;

    pub fn with_max_items(mut self, max_items: usize) -> Self {
        self.max_items = Some(max_items);
        self
    }

    pub fn max_items(&self) -> usize {
        self.max_items.unwrap_or(Self::DEFAULT_MAX_ITEM)
    }
}

#[derive(Debug)]
#[derive(Clone)]
pub struct Config {
    pub debug_check: Option<bool>,
    pub root_path: String,
    pub block_config: BlockConfig,
    pub block_cache: BlockCacheConfig,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            debug_check: None,
            root_path: "./.rotbl/".to_string(),
            block_config: Default::default(),
            block_cache: Default::default(),
        }
    }
}

impl Config {
    #[allow(dead_code)]
    pub fn new(root_path: String) -> Self {
        Self {
            root_path,
            ..Default::default()
        }
    }

    pub fn with_debug_check(mut self, debug_check: bool) -> Self {
        self.debug_check = Some(debug_check);
        self
    }

    pub fn with_root_path(mut self, root_path: impl ToString) -> Self {
        self.root_path = root_path.to_string();
        self
    }

    pub fn with_block_config(mut self, block_config: BlockConfig) -> Self {
        self.block_config = block_config;
        self
    }

    pub fn with_block_cache_config(mut self, block_cache_config: BlockCacheConfig) -> Self {
        self.block_cache = block_cache_config;
        self
    }

    /// Return true if debug check is enabled. Default is true.
    pub fn debug_check(&self) -> bool {
        self.debug_check.unwrap_or(true)
    }

    pub fn disable_cache(&mut self) {
        self.block_cache.capacity = Some(0);
    }

    pub fn block_cache_mut(&mut self) -> &mut BlockCacheConfig {
        &mut self.block_cache
    }
}