salak 0.6.1

A rust configuration loader
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use crate::source::FileConfig;
use crate::*;

/// An implementation of [`Environment`] for registering [`PropertySource`].
#[allow(missing_debug_implementations)]
pub struct SourceRegistry {
    #[allow(dead_code)]
    conf: Option<FileConfig>,
    #[cfg(feature = "enable_derive")]
    pub(crate) default: Option<MapPropertySource>,
    sources: Vec<Box<dyn PropertySource>>,
}
impl SourceRegistry {
    /// Create an empty registry.
    pub fn new() -> Self {
        #[allow(unused_mut)]
        let mut sr = SourceRegistry {
            conf: None,
            #[cfg(feature = "enable_derive")]
            default: None,
            sources: vec![],
        };

        #[cfg(feature = "enable_rand")]
        sr.register_source(Box::new(crate::source::rand::Random));
        sr
    }

    /// Add default command line arguments parser.
    #[cfg(feature = "enable_clap")]
    #[cfg_attr(docsrs, doc(cfg(feature = "enable_clap")))]
    pub fn with_args(mut self, mode: SysArgsMode) -> Self {
        self.register_source(Box::new(SysArgs::new(mode).0));
        self
    }

    /// Add system environment.
    pub fn with_sys_env(mut self) -> Self {
        self.register_source(Box::new(SysEnvPropertySource::new()));
        self
    }

    #[allow(dead_code)]
    fn build_conf(&mut self) -> FileConfig {
        match &self.conf {
            Some(v) => v.clone(),
            _ => {
                let v = FileConfig::new(self);
                self.conf = Some(v.clone());
                v
            }
        }
    }

    /// Add toml support.
    #[cfg(feature = "enable_toml")]
    #[cfg_attr(docsrs, doc(cfg(feature = "enable_toml")))]
    pub fn with_toml(mut self) -> Result<Self, PropertyError> {
        let fc = self.build_conf();
        self.register_sources(fc.build(Toml)?);
        Ok(self)
    }

    /// Add yaml support.
    #[cfg(feature = "enable_yaml")]
    #[cfg_attr(docsrs, doc(cfg(feature = "enable_yaml")))]
    pub fn with_yaml(mut self) -> Result<Self, PropertyError> {
        let fc = self.build_conf();
        self.register_sources(fc.build(Yaml)?);
        Ok(self)
    }

    /// Add yaml support.
    // #[cfg(feature = "enable_yaml")]
    // #[cfg_attr(docsrs, doc(cfg(feature = "enable_yaml")))]
    // pub fn with_yaml(mut self) -> Self {
    //     let fc = self.build_conf();
    //     self.register_sources(fc.build(crate::yaml::Yaml));
    //     self
    // }

    /// Register source.
    pub fn register_source(&mut self, source: Box<dyn PropertySource>) {
        if !source.is_empty() {
            #[cfg(feature = "enable_log")]
            debug!("Load property source {}.", source.name());
            self.sources.push(source);
        }
    }

    /// Register multiple sources.
    pub fn register_sources(&mut self, sources: Vec<Box<dyn PropertySource>>) {
        for source in sources.into_iter() {
            self.register_source(source);
        }
    }
}

impl Default for SourceRegistry {
    fn default() -> Self {
        let mut sr = SourceRegistry::new();
        #[cfg(not(test))]
        #[cfg(feature = "enable_clap")]
        {
            sr = sr.with_args(SysArgsMode::Auto(auto_read_sys_args_param!()));
        }
        sr = sr.with_sys_env();
        #[cfg(feature = "enable_toml")]
        {
            sr = sr.with_toml().expect("Toml load failed");
        }
        #[cfg(feature = "enable_yaml")]
        {
            sr = sr.with_yaml().expect("Yaml load failed");
        }
        sr
    }
}

impl Environment for SourceRegistry {
    fn contains(&self, name: &str) -> bool {
        self.sources.iter().any(|a| a.contains_property(name))
    }
    fn require<T: FromEnvironment>(&self, name: &str) -> Result<T, PropertyError> {
        let mut x = None;
        if !name.is_empty() {
            for ps in self.sources.iter() {
                if let Some(v) = ps.get_property(name) {
                    x = Some(v);
                    break;
                }
            }
            #[cfg(feature = "enable_derive")]
            if x.is_none() {
                if let Some(ps) = &self.default {
                    x = ps.get_property(name);
                }
            }
        }
        T::from_env(name, x, self)
    }

    fn resolve_placeholder(&self, v: String) -> Result<Option<Property>, PropertyError> {
        Err(PropertyError::ParseFail(format!(
            "Placeholder not implement: {}",
            v
        )))
    }
    fn find_keys(&self, prefix: &str) -> Vec<String> {
        let s: HashSet<String> = self
            .sources
            .iter()
            .flat_map(|p| p.get_keys(prefix))
            .collect();
        s.into_iter().collect()
    }
    fn reload(&mut self) -> Result<(), PropertyError> {
        for ps in self.sources.iter_mut() {
            if let Some(p) = ps.load()? {
                *ps = p;
            }
        }
        Ok(())
    }
}