cfgmatic-paths 2.2.0

Cross-platform configuration path discovery following XDG and platform conventions
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

//! Configuration tier definitions.

/// Configuration tier represents the priority level of a configuration source.
///
/// Tiers are ordered by priority: User > Local > System.
/// When merging configurations, User tier overrides Local,
/// and Local overrides System.
///
/// The enum's discriminant values directly represent priority levels,
/// allowing use via `u8::from(tier)` or `tier as u8`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
pub enum ConfigTier {
    /// System-wide configuration.
    /// Lowest priority, typically in `/etc/`.
    /// Examples: `/etc/app/`, `/etc/xdg/app/`
    System = 1,

    /// Local/machine-specific configuration.
    /// Medium priority, typically in `/usr/local/etc` or similar.
    /// Examples: `/usr/local/etc/app/`, `/opt/app/etc/`
    Local = 2,

    /// User-specific configuration.
    /// Highest priority, typically in user's home directory.
    /// Examples: `~/.config/app/`, `~/.apprc`
    #[default]
    User = 3,
}

impl From<ConfigTier> for u8 {
    fn from(tier: ConfigTier) -> Self {
        tier as Self
    }
}

impl ConfigTier {
    /// Returns true if this tier is user-level.
    #[must_use]
    pub const fn is_user(self) -> bool {
        matches!(self, Self::User)
    }

    /// Returns true if this tier is local-level.
    #[must_use]
    pub const fn is_local(self) -> bool {
        matches!(self, Self::Local)
    }

    /// Returns true if this tier is system-level.
    #[must_use]
    pub const fn is_system(self) -> bool {
        matches!(self, Self::System)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_tier_ordering() {
        assert!(ConfigTier::User > ConfigTier::Local);
        assert!(ConfigTier::Local > ConfigTier::System);
        assert!(ConfigTier::User > ConfigTier::System);
    }

    #[test]
    fn test_priority_values() {
        assert_eq!(u8::from(ConfigTier::User), 3);
        assert_eq!(u8::from(ConfigTier::Local), 2);
        assert_eq!(u8::from(ConfigTier::System), 1);
    }
}