confique 0.4.0

Type-safe, layered, light-weight, `serde`-based 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
75
76

#[cfg(any(feature = "toml", feature = "yaml", feature = "json5"))]
use std::path::PathBuf;

use crate::{Config, Error, Layer};

#[cfg(any(feature = "toml", feature = "yaml", feature = "json5"))]
use crate::File;



/// Convenience builder to configure, load and merge multiple configuration
/// sources.
///
/// **Sources specified earlier have a higher priority**. Obtained via
/// [`Config::builder`].
pub struct Builder<C: Config> {
    sources: Vec<Source<C>>,
}

impl<C: Config> Builder<C> {
    pub(crate) fn new() -> Self {
        Self { sources: vec![] }
    }

    /// Adds a configuration file as source. Infers the format from the file
    /// extension. If the path has no file extension or the extension is
    /// unknown, [`Builder::load`] will return an error.
    ///
    /// The file is not considered required: if the file does not exist, an
    /// empty configuration (`C::Layer::empty()`) is used for this layer.
    #[cfg(any(feature = "toml", feature = "yaml", feature = "json5"))]
    pub fn file(mut self, path: impl Into<PathBuf>) -> Self {
        self.sources.push(Source::File(path.into()));
        self
    }

    /// Adds the environment variables as a source.
    pub fn env(mut self) -> Self {
        self.sources.push(Source::Env);
        self
    }

    /// Adds an already loaded configuration layer as source.
    pub fn preloaded(mut self, layer: C::Layer) -> Self {
        self.sources.push(Source::Preloaded(layer));
        self
    }

    /// Loads all configured sources in order. Earlier sources have a higher
    /// priority, later sources only fill potential gaps.
    ///
    /// Will return an error if loading the sources fails or if the merged
    /// configuration does not specify all required values.
    pub fn load(self) -> Result<C, Error> {
        let mut partial = C::Layer::empty();
        for source in self.sources {
            let layer = match source {
                #[cfg(any(feature = "toml", feature = "yaml", feature = "json5"))]
                Source::File(path) => File::new(path)?.load()?,
                Source::Env => C::Layer::from_env()?,
                Source::Preloaded(p) => p,
            };

            partial = partial.with_fallback(layer);
        }

        C::from_layer(partial.with_fallback(C::Layer::default_values()))
    }
}

enum Source<C: Config> {
    #[cfg(any(feature = "toml", feature = "yaml", feature = "json5"))]
    File(PathBuf),
    Env,
    Preloaded(C::Layer),
}