kglite 0.13.4

Pure-Rust embedded Cypher knowledge graph engine with in-memory, mmap, and disk storage, agent-facing schema introspection, and optional dataset loaders
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

//! Filesystem layout for the Wikidata workdir.
//!
//! The crate is responsible only for the *dump* tier — the cached
//! `.nt.bz2` file and its in-progress `.part`. The built graph
//! (`workdir/graph[_<N>m]/`) is the main `kglite` crate's concern, so
//! it is not modelled here.

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

/// The Wikimedia `latest-truthy` dump filename.
pub const DUMP_FILE: &str = "latest-truthy.nt.bz2";

/// Canonical URL of the upstream dump.
pub const DUMP_URL: &str = "https://dumps.wikimedia.org/wikidatawiki/entities/latest-truthy.nt.bz2";

/// Resolved dump paths for one Wikidata workdir.
#[derive(Debug, Clone)]
pub struct Workdir {
    root: PathBuf,
}

impl Workdir {
    pub fn new(root: impl Into<PathBuf>) -> Self {
        Self { root: root.into() }
    }

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

    /// `latest-truthy.nt.bz2` — the cached dump.
    pub fn dump_path(&self) -> PathBuf {
        self.root.join(DUMP_FILE)
    }

    /// `latest-truthy.nt.bz2.part` — the in-progress resumable download.
    pub fn part_path(&self) -> PathBuf {
        self.root.join(format!("{DUMP_FILE}.part"))
    }

    /// Create the workdir directory (idempotent).
    pub fn ensure_dir(&self) -> std::io::Result<()> {
        std::fs::create_dir_all(&self.root)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn paths_are_well_formed() {
        let w = Workdir::new("/tmp/wd");
        assert_eq!(w.dump_path(), Path::new("/tmp/wd/latest-truthy.nt.bz2"));
        assert_eq!(
            w.part_path(),
            Path::new("/tmp/wd/latest-truthy.nt.bz2.part")
        );
    }
}