more-config 2.1.5

Provides support for configuration
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

use crate::{
    util::accumulate_child_keys, ConfigurationBuilder, ConfigurationProvider, ConfigurationSource,
    LoadResult, Value,
};
use std::collections::HashMap;
use std::env::vars;

/// Represents a [`ConfigurationProvider`](crate::ConfigurationProvider) for environment variables.
#[derive(Default)]
pub struct EnvironmentVariablesConfigurationProvider {
    prefix: String,
    data: HashMap<String, (String, Value)>,
}

impl EnvironmentVariablesConfigurationProvider {
    /// Initializes a new environment variables configuration provider.
    ///
    /// # Arguments
    ///
    /// * `prefix` - A prefix used to filter the environment variables
    pub fn new(prefix: String) -> Self {
        Self {
            prefix,
            data: HashMap::with_capacity(0),
        }
    }
}

impl ConfigurationProvider for EnvironmentVariablesConfigurationProvider {
    fn get(&self, key: &str) -> Option<Value> {
        self.data.get(&key.to_uppercase()).map(|t| t.1.clone())
    }

    fn load(&mut self) -> LoadResult {
        let mut data = HashMap::new();
        let prefix = self.prefix.to_uppercase();
        let prefix_len = self.prefix.len();

        for (key, value) in vars() {
            if key.to_uppercase().starts_with(&prefix) {
                let new_key = key[prefix_len..].to_string();
                data.insert(new_key.to_uppercase().replace("__", ":"), (new_key, value.into()));
            }
        }

        data.shrink_to_fit();
        self.data = data;
        Ok(())
    }

    fn child_keys(&self, earlier_keys: &mut Vec<String>, parent_path: Option<&str>) {
        accumulate_child_keys(&self.data, earlier_keys, parent_path)
    }
}

/// Represents a [`ConfigurationSource`](crate::ConfigurationSource) for environment variables.
#[derive(Default)]
pub struct EnvironmentVariablesConfigurationSource {
    /// A prefix used to filter environment variables.
    pub prefix: String,
}

impl EnvironmentVariablesConfigurationSource {
    /// Initializes a new environment variables configuration source.
    ///
    /// # Arguments
    ///
    /// * `prefix` - A prefix used to filter environment variables
    pub fn new(prefix: &str) -> Self {
        Self {
            prefix: prefix.to_owned(),
        }
    }
}

impl ConfigurationSource for EnvironmentVariablesConfigurationSource {
    fn build(&self, _builder: &dyn ConfigurationBuilder) -> Box<dyn ConfigurationProvider> {
        Box::new(EnvironmentVariablesConfigurationProvider::new(
            self.prefix.clone(),
        ))
    }
}

pub mod ext {

    use super::*;

    /// Defines extension methods for [`ConfigurationBuilder`](crate::ConfigurationBuilder).
    pub trait EnvironmentVariablesExtensions {
        /// Adds environment variables as a configuration source.
        fn add_env_vars(&mut self) -> &mut Self;

        /// Adds environment variables as a configuration source.
        ///
        /// # Arguments
        ///
        /// * `prefix` - The prefix that environment variable names must start with.
        ///              The prefix will be removed from the environment variable names.
        fn add_env_vars_with_prefix(&mut self, prefix: &str) -> &mut Self;
    }

    impl EnvironmentVariablesExtensions for dyn ConfigurationBuilder + '_ {
        fn add_env_vars(&mut self) -> &mut Self {
            self.add_env_vars_with_prefix("")
        }

        fn add_env_vars_with_prefix(&mut self, prefix: &str) -> &mut Self {
            self.add(Box::new(EnvironmentVariablesConfigurationSource::new(
                prefix,
            )));
            self
        }
    }

    impl<T: ConfigurationBuilder> EnvironmentVariablesExtensions for T {
        fn add_env_vars(&mut self) -> &mut Self {
            self.add_env_vars_with_prefix("")
        }

        fn add_env_vars_with_prefix(&mut self, prefix: &str) -> &mut Self {
            self.add(Box::new(EnvironmentVariablesConfigurationSource::new(
                prefix,
            )));
            self
        }
    }
}