axiomsync 1.0.0

Core data-processing engine for AxiomSync local retrieval runtime.
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

use std::path::PathBuf;

use crate::error::{AxiomError, Result};
use crate::fs::LocalContextFs;
use crate::uri::AxiomUri;

const ABSTRACT_FILE_NAME: &str = ".abstract.md";
const OVERVIEW_FILE_NAME: &str = ".overview.md";

pub(crate) fn abstract_uri(uri: &AxiomUri) -> Result<AxiomUri> {
    uri.join(ABSTRACT_FILE_NAME)
}

pub(crate) fn overview_uri(uri: &AxiomUri) -> Result<AxiomUri> {
    uri.join(OVERVIEW_FILE_NAME)
}

pub(crate) fn abstract_path(fs: &LocalContextFs, uri: &AxiomUri) -> PathBuf {
    fs.resolve_uri(uri).join(ABSTRACT_FILE_NAME)
}

pub(crate) fn overview_path(fs: &LocalContextFs, uri: &AxiomUri) -> PathBuf {
    fs.resolve_uri(uri).join(OVERVIEW_FILE_NAME)
}

pub(crate) fn read_abstract(fs: &LocalContextFs, uri: &AxiomUri) -> Result<String> {
    let target_uri = abstract_uri(uri)?;
    if !fs.exists(&target_uri) {
        return Err(AxiomError::NotFound(format!("missing abstract for {uri}")));
    }
    if fs.is_dir(&target_uri) {
        return Err(AxiomError::Validation(format!(
            "abstract path is a directory: {uri}"
        )));
    }
    fs.read(&target_uri)
}

pub(crate) fn read_overview(fs: &LocalContextFs, uri: &AxiomUri) -> Result<String> {
    let target_uri = overview_uri(uri)?;
    if !fs.exists(&target_uri) {
        return Err(AxiomError::NotFound(format!("missing overview for {uri}")));
    }
    if fs.is_dir(&target_uri) {
        return Err(AxiomError::Validation(format!(
            "overview path is a directory: {uri}"
        )));
    }
    fs.read(&target_uri)
}

pub(crate) fn write_tiers(
    fs: &LocalContextFs,
    uri: &AxiomUri,
    abstract_md: &str,
    overview_md: &str,
    system: bool,
) -> Result<()> {
    fs.create_dir_all(uri, system)?;
    let abstract_uri = abstract_uri(uri)?;
    let overview_uri = overview_uri(uri)?;
    fs.write(&abstract_uri, abstract_md, system)?;
    fs.write(&overview_uri, overview_md, system)?;
    Ok(())
}