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

use crate::errors::{DbError, DbResult};
use std::path::{Path, PathBuf};

/// db-rs's config that describes where the log file should be and how the database should behave.
/// use [Config::in_folder] as a starting point.
#[derive(Clone, Debug)]
pub struct Config {
    /// folder where db-rs can write it's log
    pub path: PathBuf,

    /// should db-rs create parent folders that don't exist? Default: true
    pub create_path: bool,

    /// should db-rs create a log if one doesn't exist? Default: true
    pub create_db: bool,

    /// should db-rs only read and not write? (good for analysis tooling) Default: false
    pub read_only: bool,

    /// should db-rs avoid all IO? (good for tests) Default: false
    pub no_io: bool,

    /// should db-rs guard it's log file with a file lock? (good for CLIs) Default: true
    pub fs_locks: bool,

    /// if using fs_locks, should we block while trying to aquire a lock? Default: false
    pub fs_locks_block: bool,

    #[doc(hidden)]
    pub schema_name: Option<String>,
}

impl Config {
    fn base() -> Self {
        Self {
            path: Default::default(),
            schema_name: None,
            create_path: true,
            create_db: true,
            read_only: false,
            no_io: false,
            fs_locks: true,
            fs_locks_block: false,
        }
    }

    pub fn no_io() -> Self {
        Self {
            path: Default::default(),
            schema_name: None,
            create_path: false,
            create_db: false,
            read_only: true,
            no_io: true,
            fs_locks: false,
            fs_locks_block: false,
        }
    }

    pub fn in_folder<P>(p: P) -> Self
    where
        P: AsRef<Path>,
    {
        Self { path: PathBuf::from(p.as_ref()), ..Self::base() }
    }

    pub fn db_location_v2(&self) -> DbResult<PathBuf> {
        let name = self.schema_name.as_ref().ok_or(DbError::Unexpected(
            "Schema name not populated! db-rs-derive should have done this",
        ))?;
        let mut pathbuf = self.path.clone();
        pathbuf.push(format!("{name}.db"));
        Ok(pathbuf)
    }

    pub fn db_location_v1(&self) -> DbResult<PathBuf> {
        let name = self.schema_name.as_ref().ok_or(DbError::Unexpected(
            "Schema name not populated! db-rs-derive should have done this",
        ))?;
        let mut pathbuf = self.path.clone();
        pathbuf.push(name);
        Ok(pathbuf)
    }

    pub fn compaction_location(&self) -> DbResult<PathBuf> {
        let name = self.schema_name.as_ref().ok_or(DbError::Unexpected(
            "Schema name not populated! db-rs-derive should have done this",
        ))?;
        let mut pathbuf = self.path.clone();
        pathbuf.push(format!("{name}.db.tmp"));
        Ok(pathbuf)
    }
}