libset 0.1.6

A configuration file management library for Rust applications.
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

use thiserror::Error;

/// Custom error type for the library.
#[derive(Debug, Error)]
pub enum Error {
    /// Represents an invalid application name.
    #[error("'{0}' is not a valid application name, avoid using . or .. .")]
    InvalidName(String),
    /// Represents a failure to write to a file.
    #[error("Failed to write to file: {0}")]
    Write(atomicwrites::Error<std::io::Error>),
    /// Represents a filesystem error.
    #[error("Filesystem error: {0}")]
    Io(std::io::Error),
    /// Represents a missing configuration directory.
    #[error("Config directory not found")]
    NoConfigDirectory,
    /// Represents a failure to get a key.
    #[error("Failed to get key {0} : {1}")]
    GetKey(String, std::io::Error),
    /// Represents a failure to parse a ron file.
    #[cfg(feature = "ron")]
    #[error("Failed to parse ron file: {0}")]
    Ron(ron::Error),
    /// Represents a failure to parse a ron file with span information.
    #[cfg(feature = "ron")]
    #[error("Failed to parse ron file: {0}")]
    RonSpanned(ron::error::SpannedError),
    /// Represents a failure to parse a json file.
    #[cfg(feature = "json")]
    #[error("Failed to parse json file: {0}")]
    Json(serde_json::Error),
    /// Represents a failure to serialize a toml file.
    #[cfg(feature = "toml")]
    #[error("Failed to serialize toml file: {0}")]
    TomlSerialize(toml::ser::Error),
    /// Represents a failure to deserialize a toml file.
    #[cfg(feature = "toml")]
    #[error("Failed to deserialize toml file: {0}")]
    TomlDeserialize(toml::de::Error),
    /// Represents a generic string error.
    #[error("An error ocurred: {0}")]
    Generic(String),
}

impl From<String> for Error {
    fn from(f: String) -> Self {
        Self::Generic(f)
    }
}

impl From<atomicwrites::Error<std::io::Error>> for Error {
    fn from(f: atomicwrites::Error<std::io::Error>) -> Self {
        Self::Write(f)
    }
}

impl From<std::io::Error> for Error {
    fn from(f: std::io::Error) -> Self {
        Self::Io(f)
    }
}

#[cfg(feature = "ron")]
impl From<ron::Error> for Error {
    fn from(f: ron::Error) -> Self {
        Self::Ron(f)
    }
}

#[cfg(feature = "ron")]
impl From<ron::error::SpannedError> for Error {
    fn from(f: ron::error::SpannedError) -> Self {
        Self::RonSpanned(f)
    }
}

#[cfg(feature = "json")]
impl From<serde_json::Error> for Error {
    fn from(f: serde_json::Error) -> Self {
        Self::Json(f)
    }
}

#[cfg(feature = "toml")]
impl From<toml::de::Error> for Error {
    fn from(f: toml::de::Error) -> Self {
        Self::TomlDeserialize(f)
    }
}

#[cfg(feature = "toml")]
impl From<toml::ser::Error> for Error {
    fn from(f: toml::ser::Error) -> Self {
        Self::TomlSerialize(f)
    }
}