tier 0.1.17

Rust configuration library for layered TOML, env, and CLI settings
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

mod external;
mod macro_helpers;
mod pattern;
mod value;

pub(crate) use self::external::{
    ExternalPathSegment, normalize_external_path, parse_external_path, render_external_path,
};
pub use self::macro_helpers::{PathPatternItem, normalize_macro_path, pattern_item_ref};
pub(crate) use self::pattern::{
    canonicalize_path_with_aliases, concrete_paths_overlap, direct_child_array_index, join_path,
    normalize_path, path_child_segments, path_is_at_or_below, path_matches_pattern,
    path_overlaps_pattern, path_segments, path_starts_with_pattern,
};
pub(crate) use self::value::{collect_diff_paths, collect_paths, get_value_at_path, redact_value};

/// Builds a compile-time checked dot path from a config type.
///
/// This macro keeps field names refactor-safe for runtime APIs that still
/// accept string paths, such as manual metadata, validators, `env_decoder`,
/// and report lookup helpers.
///
/// ```rust
/// use serde::{Deserialize, Serialize};
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct DbConfig {
///     token: String,
/// }
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct AppConfig {
///     db: DbConfig,
/// }
///
/// assert_eq!(tier::path!(AppConfig.db.token), "db.token");
/// ```
#[macro_export]
macro_rules! path {
    ($root:ident $(:: $root_tail:ident)* . $segment:tt $(. $rest:tt)*) => {{
        let _ = |__tier_value: &$root $(:: $root_tail)*| {
            let _ = &$crate::__tier_path_check!((__tier_value).$segment $(. $rest)*);
        };
        $crate::path::normalize_macro_path(stringify!($segment $(. $rest)*))
    }};
}

/// Builds a compile-time checked wildcard path from a config type.
///
/// Use this macro for collection item paths such as `services.*.token`.
/// Wildcard segments are type-checked against common collection containers
/// like `Vec<T>`, arrays, maps, and sets.
///
/// ```rust
/// use std::collections::BTreeMap;
/// use serde::{Deserialize, Serialize};
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct ServiceConfig {
///     token: String,
/// }
///
/// #[derive(Debug, Clone, Serialize, Deserialize)]
/// struct AppConfig {
///     services: BTreeMap<String, ServiceConfig>,
/// }
///
/// assert_eq!(tier::path_pattern!(AppConfig.services.*.token), "services.*.token");
/// ```
#[macro_export]
macro_rules! path_pattern {
    ($root:ident $(:: $root_tail:ident)* . $segment:tt $(. $rest:tt)*) => {{
        let _ = |__tier_value: &$root $(:: $root_tail)*| {
            $crate::__tier_path_pattern_check!((__tier_value).$segment $(. $rest)*);
        };
        $crate::path::normalize_macro_path(stringify!($segment $(. $rest)*))
    }};
}

#[doc(hidden)]
#[macro_export]
macro_rules! __tier_path_check {
    (($value:expr) . $segment:tt) => {
        $value.$segment
    };
    (($value:expr) . $segment:tt $(. $rest:tt)+) => {
        $crate::__tier_path_check!(($value.$segment) $(. $rest)+)
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! __tier_path_pattern_check {
    (($value:expr) . *) => {
        if false {
            let _ = $crate::path::pattern_item_ref($value);
        }
    };
    (($value:expr) . * $(. $rest:tt)+) => {
        if false {
            if let Some(__tier_item) = $crate::path::pattern_item_ref($value) {
                $crate::__tier_path_pattern_check!((__tier_item) $(. $rest)+);
            }
        }
    };
    (($value:expr) . $segment:tt) => {
        if false {
            let _ = &$value.$segment;
        }
    };
    (($value:expr) . $segment:tt $(. $rest:tt)+) => {
        $crate::__tier_path_pattern_check!((&$value.$segment) $(. $rest)+);
    };
}