nidus-config 1.0.4

Typed configuration values and environment loading utilities for Nidus 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

use serde::de::DeserializeOwned;
use serde_json::Value;

/// Result type for configuration operations.
pub type Result<T> = std::result::Result<T, ConfigError>;

/// Errors emitted by typed configuration loading.
#[derive(Debug, thiserror::Error)]
pub enum ConfigError {
    /// Parsing a JSON configuration source failed.
    #[error("configuration JSON parse error: {0}")]
    Parse(#[source] serde_json::Error),

    /// The configuration root was not a JSON object.
    #[error("configuration root must be a JSON object")]
    RootNotObject,

    /// Reading a JSON configuration file failed.
    #[error("configuration file `{path}` read error: {source}")]
    ReadFile {
        /// Configuration file path.
        path: String,
        /// Underlying IO error.
        #[source]
        source: std::io::Error,
    },

    /// Parsing a JSON configuration file failed.
    #[error("configuration file `{path}` JSON parse error: {source}")]
    ParseFile {
        /// Configuration file path.
        path: String,
        /// Underlying serde error.
        #[source]
        source: serde_json::Error,
    },

    /// A JSON configuration file root was not an object.
    #[error("configuration file `{path}` root must be a JSON object")]
    FileRootNotObject {
        /// Configuration file path.
        path: String,
    },

    /// Deserialization into the requested type failed.
    #[error("configuration deserialize error: {0}")]
    Deserialize(#[from] serde_json::Error),

    /// Deserialization of one configuration value failed.
    #[error("configuration deserialize error at `{path}`: {source}")]
    ValueDeserialize {
        /// Configuration key or dot-separated path that failed.
        path: String,
        /// Underlying serde error.
        #[source]
        source: serde_json::Error,
    },

    /// A required configuration value was missing.
    #[error("missing required configuration value `{path}`")]
    MissingValue {
        /// Missing configuration key or dot-separated path.
        path: String,
    },
}

pub(crate) fn deserialize_value<T>(path: String, value: Value) -> Result<T>
where
    T: DeserializeOwned,
{
    serde_json::from_value(value).map_err(|source| ConfigError::ValueDeserialize { path, source })
}