dumbo_config 0.3.3

a config 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

use std::fmt;
use std::path::Path;

const DEFAULT_SEPERATOR: &str = "__";

/// Environment configuration for loading settings from environment variables
pub struct EnvConfig {
    pub name: String,              // Environment variable prefix
    pub separator: Option<String>, // Environment variable separator, defaults to "_"
}

impl EnvConfig {
    /// Creates a new EnvConfig with the given name and optional separator
    pub fn new(name: String, separator: Option<String>) -> Self {
        Self { name, separator }
    }

    /// Gets the separator, defaulting to "_" if not specified
    pub fn get_separator(&self) -> &str {
        self.separator.as_deref().unwrap_or(DEFAULT_SEPERATOR)
    }
}

/// Loading parameters for configuration
///
/// Note: env_prefix has higher priority than file, meaning if both are present,
/// settings from env_prefix will override those from file.
pub struct LoadingParam<'a> {
    pub file: Option<&'a Path>,        // Configuration file path
    pub env_prefix: Option<EnvConfig>, // Environment variable configuration
}

/// Configuration loading errors
#[derive(Debug)]
pub enum ConfigError {
    /// Wrapped config crate error
    Config(config::ConfigError),
    /// Configuration file not found
    FileNotFound(std::path::PathBuf),
    /// SHOW_SETTINGS environment variable cannot be parsed as boolean
    ShowSettingsParseError(String),
    /// Invalid loading parameter: both file and env_prefix are None
    InvalidLoadingParam,
    /// Invalid environment configuration: env prefix contains separator
    InvalidEnvConfig { prefix: String, separator: String },
}

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConfigError::Config(err) => write!(f, "Config error: {}", err),
            ConfigError::FileNotFound(path) => {
                write!(f, "Configuration file not found: {:?}", path)
            }
            ConfigError::ShowSettingsParseError(value) => {
                write!(
                    f,
                    "Cannot parse SHOW_SETTINGS environment variable '{}' as boolean",
                    value
                )
            }
            ConfigError::InvalidLoadingParam => {
                write!(f, "No configuration source provided. Please configure at least one of:\n\
                          - Configuration file (set the 'file' parameter)\n\
                          - Environment variables (set the 'env_prefix' parameter with a valid prefix)")
            }
            ConfigError::InvalidEnvConfig { prefix, separator } => {
                write!(f, "Invalid environment configuration: env prefix '{}' contains separator '{}'.\n\
                          This will cause configuration loading to fail. Please choose a prefix that doesn't contain the separator,\n\
                          or use a different separator character.", prefix, separator)
            }
        }
    }
}

impl std::error::Error for ConfigError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            ConfigError::Config(err) => Some(err),
            _ => None,
        }
    }
}

impl From<config::ConfigError> for ConfigError {
    fn from(err: config::ConfigError) -> Self {
        ConfigError::Config(err)
    }
}