elph-core 0.0.9

Shared core utilities for Elph applications
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

use std::path::{Path, PathBuf};

use super::types::MemzConfig;
use super::{EmbedFn, MemoryStore};

/// Default data directory name for a standalone memz store.
pub const DEFAULT_DATA_DIR: &str = ".memz";

/// Database file name inside the data directory.
pub const DB_FILE_NAME: &str = "memory.db";

/// Resolved filesystem paths for a memz store.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MemzPaths {
    pub data_dir: PathBuf,
}

impl MemzPaths {
    pub fn new(data_dir: impl AsRef<Path>) -> Self {
        Self {
            data_dir: data_dir.as_ref().to_path_buf(),
        }
    }

    /// Project-local default: `./.memz`
    pub fn project_local() -> Self {
        Self::new(DEFAULT_DATA_DIR)
    }

    pub fn data_dir(&self) -> &Path {
        &self.data_dir
    }

    pub fn db_path(&self) -> PathBuf {
        self.data_dir.join(DB_FILE_NAME)
    }

    pub fn db_path_string(&self) -> String {
        self.db_path().to_string_lossy().into_owned()
    }

    pub fn exists(&self) -> bool {
        self.db_path().is_file()
    }

    /// Build a [`MemzConfig`] for this location.
    pub fn config(&self, session_id: impl Into<String>) -> MemzConfig {
        MemzConfig::new(self.db_path_string(), session_id)
    }

    /// Open a [`MemoryStore`] at this location with the given embedder.
    pub fn open(&self, session_id: impl Into<String>, embed: EmbedFn) -> MemoryStore {
        MemoryStore::new(self.config(session_id), embed)
    }
}