hierconf-core 0.5.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

pub mod attrs;
pub mod error;
pub mod loader;

pub use attrs::{Attr as HierConfAttr, extract_app_name};
#[cfg(feature = "mangen")]
pub use attrs::{extract_date, extract_synopsis, extract_type_doc, extract_type_name, is_hidden};
pub use error::HierConfError;
pub use loader::config_paths;

use facet::Facet;

/// Load configuration from standard Unix hierarchy paths.
///
/// Loads the first existing file from (in precedence order):
/// 1. User-specific: `$XDG_CONFIG_HOME/{app_name}/config.toml` or `$HOME/.config/{app_name}/config.toml` (Linux/BSD), `$HOME/Library/Application Support/{app_name}/config.toml` (macOS) - requires `user-config` feature
/// 2. System-wide: `/etc/{app_name}/config.toml`
/// 3. Distribution: `$HIERCONF_DISTRIBUTION_PREFIX/{app_name}/config.toml` (if env var set at compile time)
/// 4. Distribution: `/usr/share/etc/{app_name}/config.toml`
///
/// The `app_name` is extracted from the `#[facet(hierconf::app_name("..."))]` attribute.
pub fn load_config<T>() -> Result<T, HierConfError>
where
    T: Facet<'static>,
{
    loader::load_config::<T>()
}