lum_config 0.2.0

lum framework's config 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

use std::io;

use lum_libs::{serde_env, serde_json, thiserror::Error};

/// Error that can occur when trying to get the OS-specific config directory.
#[derive(Debug, Error)]
pub enum ConfigPathError {
    #[error("Unable to get OS-specific config directory")]
    UnknownConfigDirectory,
}

/// Error that can occur when trying to save a configuration to a file.
#[derive(Debug, Error)]
pub enum ConfigSaveError {
    #[error("Unable to serialize config: {0}")]
    Serde(#[from] serde_json::Error),

    #[error("I/O error: {0}")]
    IO(#[from] io::Error),
}

/// Error that can occur when trying to parse a configuration from a file.
#[derive(Debug, Error)]
pub enum FileConfigParseError {
    #[error("Unable to save config: {0}")]
    Save(#[from] ConfigSaveError),

    #[error("I/O error: {0}")]
    IO(#[from] io::Error),

    #[error("Unable to serialize or deserialize config: {0}")]
    Serde(#[from] serde_json::Error),
}

/// Error that can occur when trying to parse a configuration from environment variables.
#[derive(Debug, Error)]
pub enum EnvironmentConfigParseError {
    #[error("Unable to parse environment variables: {0}")]
    SerdeEnv(#[from] serde_env::Error),
}

/// Error that can occur when trying to load a configuration.
#[derive(Debug, Error)]
pub enum ConfigLoadError {
    #[error("Unable to handle config path: {0}")]
    Path(#[from] ConfigPathError),

    #[error("Unable to parse environment config: {0}")]
    ParseEnv(#[from] EnvironmentConfigParseError),

    #[error("Unable to parse file config: {0}")]
    ParseFile(#[from] FileConfigParseError),
}