cutler 0.19.7

Powerful, declarative settings management for your Mac, with speed.
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

use anyhow::{Context, Result, bail};
use serde::{Deserialize, Serialize};
use std::path::Path;
use std::path::PathBuf;
use tokio::fs;

use crate::domains::convert::SerializablePrefValue;

/// A single defaults‑setting change.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct SettingState {
    pub domain: String,
    pub key: String,
    pub original_value: Option<SerializablePrefValue>,
}

/// Represents a snapshot.
///
/// This struct has also implemented I/O operations and functions for using across cutler's codebase,
/// in order to properly interact with the snapshot file without much hassle.
#[derive(Serialize, Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub struct LoadedSnapshot {
    pub settings: Vec<SettingState>,
    pub exec_run_count: i32,
    pub version: String,
    pub digest: String,
    #[serde(skip)]
    path: PathBuf,
}

impl LoadedSnapshot {
    #[must_use]
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Deletes the snapshot.
    pub async fn delete(&self) -> Result<()> {
        fs::remove_file(&self.path)
            .await
            .with_context(|| format!("Could not delete snapshot file {:?}.", &self.path))
    }

    /// Saves the snapshot into the designated path for the instance.
    pub async fn save(&self) -> Result<()> {
        if let Some(dir) = self.path.parent() {
            fs::create_dir_all(dir).await?;
        }

        let json = serde_json::to_string_pretty(self)?;
        fs::write(&self.path, json).await?;
        Ok(())
    }
}

pub struct Snapshot {
    path: PathBuf,
}

impl Snapshot {
    #[must_use]
    pub const fn new(path: PathBuf) -> Self {
        Self { path }
    }

    #[must_use]
    pub fn path(&self) -> &Path {
        self.path.as_path()
    }

    #[must_use]
    pub fn is_loadable(&self) -> bool {
        !self.path.as_os_str().is_empty() && self.path.try_exists().unwrap_or(false)
    }

    #[must_use]
    pub fn new_empty(&self) -> LoadedSnapshot {
        LoadedSnapshot {
            settings: vec![],
            exec_run_count: 0,
            version: env!("CARGO_PKG_VERSION").to_string(),
            digest: String::new(),
            path: self.path.clone(),
        }
    }

    /// Loads the snapshot from the given path.
    /// If deserialization of the full Snapshot fails, try to deserialize only the `settings` field.
    pub async fn load(&self) -> Result<LoadedSnapshot> {
        if self.is_loadable() {
            let txt = fs::read_to_string(&self.path).await?;
            let snap_result: Result<LoadedSnapshot, _> = serde_json::from_str(&txt);

            match snap_result {
                Ok(mut snap) => {
                    snap.path = self.path.to_owned();
                    Ok(snap)
                }
                Err(e) => {
                    // fallback settings-only deserialization
                    #[derive(Deserialize)]
                    struct SettingsOnly {
                        settings: Vec<SettingState>,
                    }

                    let settings_only_result: Result<SettingsOnly, _> = serde_json::from_str(&txt);

                    match settings_only_result {
                        Ok(settings_only) => {
                            let mut snap = self.new_empty();
                            snap.settings = settings_only.settings;
                            snap.path = self.path.to_owned();
                            Ok(snap)
                        }
                        Err(_) => {
                            bail!("Failed to deserialize snapshot: {e}")
                        }
                    }
                }
            }
        } else {
            bail!("Invalid path, cannot load.")
        }
    }
}