derive-config 2.4.2

My personal configuration library
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

#![allow(clippy::multiple_crate_versions)]

use std::{marker::Sized, path::PathBuf};

pub use derive_macros::*;
#[cfg(feature = "directories")]
pub use directories::{self};
#[cfg(feature = "dirs")]
pub use dirs::{self};
#[cfg(feature = "etcetera")]
pub use etcetera::{self};
#[cfg(feature = "json")]
pub use json::{self};
#[cfg(feature = "toml")]
pub use toml::{self};
#[cfg(feature = "yaml")]
pub use yaml::{self};

#[derive(Debug, thiserror::Error)]
pub enum ConfigError {
    #[error("None")]
    None,

    #[cfg(feature = "etcetera")]
    #[error(transparent)]
    HomeDir(#[from] etcetera::HomeDirError),

    #[error(transparent)]
    Io(#[from] std::io::Error),

    #[cfg(feature = "json")]
    #[error(transparent)]
    Json(#[from] json::Error),

    #[cfg(feature = "toml")]
    #[error(transparent)]
    TomlDe(#[from] toml::de::Error),

    #[cfg(feature = "toml")]
    #[error(transparent)]
    TomlSer(#[from] toml::ser::Error),

    #[cfg(feature = "yaml")]
    #[error(transparent)]
    Yaml(#[from] yaml::Error),
}

#[duplicate::duplicate_item(
    language_struct_name;
    [ DeriveJsonConfig ];
    [ DeriveTomlConfig ];
    [ DeriveYamlConfig ];
)]
pub trait language_struct_name {
    /// # Errors
    /// Will return `Err` if `dirs::config_dir` fails.
    fn path() -> Result<PathBuf, ConfigError>;

    /// # Errors
    /// Will return `Err` if `Self::path`, `File::open`, `format::to_string`, or `File::write_all` fails.
    fn save(&self) -> Result<(), ConfigError>;

    /// # Errors
    /// Will return `Err` if `Self::path`, `File::open`, `format::to_string`, or `File::write_all` fails.
    fn and_save(self) -> Result<Self, ConfigError>
    where
        Self: Sized;

    /// # Errors
    /// Will return `Err` if `Self::path`, `File::open`, `File::read_to_string`, `File::rewind`, or `format::from_str` fails.
    fn load() -> Result<Self, ConfigError>
    where
        Self: Sized;
}