confik 0.15.12

Compose configuration from multiple sources without giving up type safety
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

use std::{error::Error, fmt::Debug};

use crate::ConfigurationBuilder;

/// A source of configuration data.
pub trait Source<T>: Debug {
    /// Whether this source is allowed to contain secret data.
    ///
    /// Implementations should be conservative and return `false` by default, allowing users to
    /// opt-in to storing secrets in this source.
    fn allows_secrets(&self) -> bool {
        false
    }

    /// Attempts to provide a partial configuration object from this source.
    fn provide(&self) -> Result<T, Box<dyn Error + Sync + Send>>;
}

#[derive(Debug)]
pub(crate) struct DefaultSource;

impl<T> Source<T> for DefaultSource
where
    T: ConfigurationBuilder,
{
    fn allows_secrets(&self) -> bool {
        true
    }

    fn provide(&self) -> Result<T, Box<dyn Error + Sync + Send>> {
        Ok(T::default())
    }
}

pub(crate) mod file_source;

#[cfg(feature = "toml")]
pub(crate) mod toml_source;

#[cfg(feature = "json")]
pub(crate) mod json_source;

#[cfg(feature = "corn-0_10")]
pub(crate) mod corn_source;

#[cfg(feature = "ron-0_12")]
pub(crate) mod ron_source;

#[cfg(feature = "env")]
pub(crate) mod env_source;

pub(crate) mod offset_source;

#[cfg(feature = "yaml_serde-0_10")]
pub(crate) mod yaml_source;

#[cfg(test)]
pub mod test {
    use std::fmt;

    use crate::{ConfigurationBuilder, Source};

    #[derive(Clone)]
    pub(crate) struct TestSource<T> {
        pub(crate) data: T,
        pub(crate) allow_secrets: bool,
    }

    impl<T> fmt::Debug for TestSource<T> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("TestSource")
                .field("allow_secrets", &self.allow_secrets)
                .finish_non_exhaustive()
        }
    }

    impl<T> Source<T> for TestSource<T>
    where
        T: ConfigurationBuilder + Clone,
    {
        fn provide(&self) -> Result<T, Box<dyn std::error::Error + Sync + Send>> {
            Ok(self.data.clone())
        }

        fn allows_secrets(&self) -> bool {
            self.allow_secrets
        }
    }
}