config-get 0.1.7

Cross-platform configuration file locator and reader for Rust. Auto-discovers .env, .ini, .toml, .json, .yml, .yaml from OS-standard locations.
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

use thiserror::Error;

/// All errors that can occur in `config-get`.
#[derive(Debug, Error)]
pub enum ConfigError {
    /// No configuration file was found in any of the searched paths.
    #[error("no configuration file found for '{0}'")]
    NotFound(String),

    /// The file could not be read from disk.
    #[error("I/O error reading '{path}': {source}")]
    Io {
        /// Path of the file that could not be read.
        path: String,
        /// Underlying I/O error.
        #[source]
        source: std::io::Error,
    },

    /// The file content could not be parsed.
    #[error("parse error in '{path}': {message}")]
    Parse {
        /// Path of the file that failed to parse.
        path: String,
        /// Human-readable description of the parse failure.
        message: String,
    },

    /// A required key was not found in the config.
    #[error("key not found: '{0}'")]
    KeyNotFound(String),

    /// The requested section was not found.
    #[error("section not found: '{0}'")]
    SectionNotFound(String),

    /// A feature required to handle this format is not enabled.
    #[error("feature '{feature}' is not enabled; recompile with `--features {feature}`")]
    FeatureNotEnabled {
        /// The Cargo feature that must be enabled.
        feature: &'static str,
    },

    /// Generic / unexpected error.
    #[error("{0}")]
    Other(String),
}

/// Convenience alias used throughout the crate.
pub type Result<T, E = ConfigError> = std::result::Result<T, E>;