notiz 1.2.0

Quickly store data on the command line
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

use std::fmt;

#[derive(Debug)]
pub enum Error {
    InvalidTypeArgument {
        given_type: String,
    },

    FileRead {
        file_path: String,
        io_error: std::io::Error,
    },

    NoteAlreadyExists {
        name: String,
    },
    NoteNotFound {
        name: String,
    },

    NoteRead {
        file_path: String,
        io_error: std::io::Error,
    },
    NoteWrite {
        file_path: String,
        io_error: std::io::Error,
    },

    StateFileNotFound {
        file_path: String,
    },
    FailedToSaveState {
        file_path: String,
        io_error: std::io::Error,
    },
    StateDeserialization {
        file_path: String,
        serde_error: toml::de::Error,
    },
    StateSerialization {
        serde_error: toml::ser::Error,
    },

    XdgError {
        xdg_error: xdg::BaseDirectoriesError,
    },
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        use Error::*;

        write!(
            f,
            "{}",
            match self {
                InvalidTypeArgument { given_type } =>
                    format!("'{}' is not a valid type", given_type),

                FileRead {
                    file_path,
                    io_error,
                } => format!("failed to read the file '{}': {}", file_path, io_error),

                NoteAlreadyExists { name } => format!(
                    "a note with the name '{}' already exists. use the '-f' option to overwrite it",
                    name
                ),
                NoteNotFound { name } => format!("could not find a note with the name '{}'", name),

                NoteRead {
                    file_path,
                    io_error,
                } => format!("failed read the note in '{}': {}", file_path, io_error),
                NoteWrite {
                    file_path,
                    io_error,
                } => format!(
                    "failed to store the notes content in '{}': {}",
                    file_path, io_error
                ),

                StateFileNotFound { file_path } => format!(
                    "tried to load the state from a file that does not exist: '{}'",
                    file_path
                ),
                FailedToSaveState {
                    file_path,
                    io_error,
                } => format!(
                    "failed to save the state to '{}': {}",
                    file_path,
                    io_error.to_string().to_lowercase()
                ),
                StateDeserialization {
                    file_path,
                    serde_error,
                } => format!(
                    "failed to deserialize the state file at '{}': {}",
                    file_path, serde_error
                ),
                StateSerialization { serde_error } =>
                    format!("failed to serialize the state: {}", serde_error),

                XdgError { xdg_error } => format!("xdg error: {}", xdg_error),
            }
        )
    }
}

impl std::error::Error for Error {}

impl From<toml::ser::Error> for Error {
    fn from(value: toml::ser::Error) -> Self {
        Self::StateSerialization { serde_error: value }
    }
}

impl From<xdg::BaseDirectoriesError> for Error {
    fn from(value: xdg::BaseDirectoriesError) -> Self {
        Self::XdgError { xdg_error: value }
    }
}