scsys-config 0.3.2

common configuration routines and schemas used throughout the ecosystem
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

/*
    Appellation: scsys-config <library>
    Contrib: @FL03
*/
//! A collection of common configuration primitives and utilities used throughout the
//! [scsys-io](https://scsys.io) ecosystem.
//!
#![cfg_attr(not(feature = "std"), no_std)]
#![crate_type = "lib"]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/scattered-systems/.github/main/assets/logo.png",
    html_favicon_url = "https://raw.githubusercontent.com/scattered-systems/.github/main/assets/favicon.ico"
)]
#![cfg(feature = "std")]
#[doc(no_inline)]
#[cfg(feature = "config")]
pub use config;

#[macro_use]
pub(crate) mod macros {
    #[macro_use]
    pub mod config;
    #[macro_use]
    pub mod seal;
}

#[doc(inline)]
pub use self::{
    consts::*, error::*, services::prelude::*, traits::prelude::*, types::prelude::*,
    utils::prelude::*,
};
/// the `error` module defines the error-handling routines for the crate
pub mod error;
pub mod services;

/// constants declared for the configuration module
pub mod consts {
    /// The default environment variable prefix used for configuration schemas.
    pub const DEFAULT_ENV_PREFIX: &str = "APP";
    /// The default environment variable separator used for configuration schemas.
    pub const DEFAULT_ENV_SEPARATOR: &str = "_";
    /// The standard artifacts directory name
    pub const ARTIFACTS: &str = ".artifacts";
    /// The standard cache directory name
    pub const CACHE_DIR: &str = ".cache";
    /// The standard configuration directory name
    pub const CONFIG_DIR: &str = ".config";
}

/// this module is used to implement various traits supporting the configuration module
pub mod traits {
    #[doc(inline)]
    pub use self::prelude::*;

    pub mod configure;

    pub(crate) mod prelude {
        #[doc(inline)]
        pub use super::configure::*;
    }
}
/// various types used throughout the configuration module
pub mod types {
    #[doc(inline)]
    pub use self::prelude::*;

    pub mod environment;
    pub mod log_level;
    pub mod mode;
    pub mod network_address;
    pub mod scope;

    pub(crate) mod prelude {
        #[doc(inline)]
        pub use super::environment::*;
        #[doc(inline)]
        pub use super::log_level::*;
        #[doc(inline)]
        pub use super::mode::*;
        #[doc(inline)]
        pub use super::network_address::*;
        #[doc(inline)]
        pub use super::scope::*;
    }
}

pub mod utils {
    #[doc(inline)]
    pub use self::prelude::*;

    pub mod fs;
    pub mod vars;

    pub(crate) mod prelude {
        #[allow(unused_imports)]
        #[doc(inline)]
        pub use super::fs::*;
        #[doc(inline)]
        pub use super::vars::*;
    }
}

pub mod prelude {
    #[doc(no_inline)]
    pub use crate::consts::*;
    #[doc(no_inline)]
    pub use crate::error::*;
    #[doc(no_inline)]
    pub use crate::services::prelude::*;
    #[doc(no_inline)]
    pub use crate::types::prelude::*;
    #[doc(no_inline)]
    pub use crate::utils::prelude::*;
}