hierconf-core 0.1.0

Core functionality for hierconf configuration management
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

use facet::{Facet, Shape};
use facet_error as error;
use facet_toml::TomlDeError;

/// Errors that can occur in hierconf.
#[repr(u8)]
#[derive(Facet, Debug)]
#[facet(derive(Error))]
pub enum HierConfError {
    /// IO error: {0}
    #[facet(error::from)]
    Io(#[facet(opaque)] std::io::Error),
    /// Error during TOML deserialization: {0}
    TomlDeserialize(String),
    /// Missing required attribute: {0}
    MissingAttribute(String),
    /// Shape mismatch for attribute {attr}: found shape {shape:?}, namespace {namespace:?}, key {key}
    AttributeShapeMismatch {
        /// The shape that was found
        #[facet(opaque)]
        shape: &'static Shape,
        /// The attribute namespace
        namespace: Option<&'static str>,
        /// The attribute key
        key: &'static str,
        /// The attribute name (e.g., "hierconf::app_name" or "hierconf::synopsis")
        attr: &'static str,
    },
    /// No configuration files found at any of the checked locations: {locations:?}
    NoConfigFiles {
        /// The list of locations that were checked
        locations: Vec<camino::Utf8PathBuf>,
    },
}

impl<'input> From<TomlDeError<'input>> for HierConfError {
    fn from(err: TomlDeError<'input>) -> Self {
        HierConfError::TomlDeserialize(err.to_string())
    }
}