runmat-config 0.6.2

Shared configuration schema and loaders for RunMat
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

mod error;
mod format;
mod legacy;
mod patch;
mod projection;
mod replace;

pub use error::RunmatConfigDocumentError;
pub use format::RunmatConfigFormat;
pub use legacy::{
    migrate_legacy_desktop_config, migrate_legacy_desktop_config_between,
    migrate_legacy_desktop_config_into, LegacyDesktopMigration,
};
pub use patch::{
    DesktopArtifactsPatch, DesktopNotebookPatch, DesktopRunHistoryPatch, DesktopScriptPatch,
    RunmatConfigPatch, RuntimeConfigPatch,
};

use crate::desktop::DesktopConfig;
use crate::runtime::RunMatRuntimeConfig;

#[derive(Clone, Debug)]
pub struct RunmatConfigDocument {
    source: String,
    format: RunmatConfigFormat,
    desktop: DesktopConfig,
    runtime: RunMatRuntimeConfig,
}

impl RunmatConfigDocument {
    pub fn parse(
        source: impl Into<String>,
        format: RunmatConfigFormat,
    ) -> Result<Self, RunmatConfigDocumentError> {
        let source = source.into();
        let projection = projection::parse_projection(&source, format)?;
        projection.desktop.validate()?;
        Ok(Self {
            source,
            format,
            desktop: projection.desktop,
            runtime: projection.runtime,
        })
    }

    pub fn parse_path(
        source: impl Into<String>,
        path: &std::path::Path,
    ) -> Result<Self, RunmatConfigDocumentError> {
        Self::parse(source, RunmatConfigFormat::from_path(path)?)
    }

    pub fn format(&self) -> RunmatConfigFormat {
        self.format
    }

    pub fn source(&self) -> &str {
        &self.source
    }

    pub fn into_source(self) -> String {
        self.source
    }

    pub fn desktop(&self) -> &DesktopConfig {
        &self.desktop
    }

    pub fn runtime(&self) -> &RunMatRuntimeConfig {
        &self.runtime
    }

    pub fn patched(&self, patch: &RunmatConfigPatch) -> Result<Self, RunmatConfigDocumentError> {
        let source = patch::apply_patch(&self.source, self.format, patch)?;
        Self::parse(source, self.format)
    }

    /// Replace the complete runtime-owned section while preserving every
    /// unrelated top-level section in the document.
    pub fn with_runtime(
        &self,
        runtime: &RunMatRuntimeConfig,
    ) -> Result<Self, RunmatConfigDocumentError> {
        let source = replace::replace_runtime(&self.source, self.format, runtime)?;
        Self::parse(source, self.format)
    }
}