solti-model 0.0.1

Solti SDK domain model.
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

//! # Boolean toggle.
//!
//! [`Flag`] provides `enabled()`/`disabled()` constructors with serde support.

use serde::{Deserialize, Serialize};

/// Universal boolean flag with explicit enable/disable semantics.
///
/// ```text
///  Flag::enabled()   ─► is_enabled() == true
///  Flag::disabled()  ─► is_enabled() == false
///  Flag::default()   ─► enabled (opt-in disable)
/// ```
///
/// ```rust
/// use solti_model::Flag;
///
/// let f = Flag::enabled();
/// assert!(f.is_enabled());
///
/// let f: Flag = false.into();
/// assert!(f.is_disabled());
///
/// let b: bool = f.into();
/// assert!(!b);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(transparent)]
pub struct Flag(bool);

impl Flag {
    /// Create an enabled flag.
    #[inline]
    pub const fn enabled() -> Self {
        Self(true)
    }

    /// Create a disabled flag.
    #[inline]
    pub const fn disabled() -> Self {
        Self(false)
    }

    /// Check if the flag is enabled.
    #[inline]
    pub const fn is_enabled(&self) -> bool {
        self.0
    }

    /// Check if the flag is disabled.
    #[inline]
    pub const fn is_disabled(&self) -> bool {
        !self.0
    }

    /// Get the raw boolean value.
    #[inline]
    pub const fn value(&self) -> bool {
        self.0
    }
}

impl Default for Flag {
    #[inline]
    fn default() -> Self {
        Self::enabled()
    }
}

impl From<bool> for Flag {
    #[inline]
    fn from(b: bool) -> Self {
        Self(b)
    }
}

impl From<Flag> for bool {
    #[inline]
    fn from(f: Flag) -> Self {
        f.0
    }
}

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

    #[test]
    fn default_is_enabled() {
        let f = Flag::default();
        assert!(f.is_enabled());
        assert!(!f.is_disabled());
        assert!(f.value());
    }

    #[test]
    fn enabled_and_disabled_constructors_work() {
        let e = Flag::enabled();
        let d = Flag::disabled();

        assert!(e.is_enabled());
        assert!(!e.is_disabled());

        assert!(!d.is_enabled());
        assert!(d.is_disabled());
    }

    #[test]
    fn from_bool_and_into_bool() {
        let f_true: Flag = true.into();
        let f_false: Flag = false.into();

        assert!(f_true.is_enabled());
        assert!(f_false.is_disabled());

        let b1: bool = f_true.into();
        let b2: bool = f_false.into();

        assert!(b1);
        assert!(!b2);
    }

    #[test]
    fn serde_transparent_roundtrip() {
        let f = Flag::disabled();
        let json = serde_json::to_string(&f).unwrap();

        assert_eq!(json, "false");
        let back: Flag = serde_json::from_str(&json).unwrap();
        assert!(back.is_disabled());
    }
}