use-check 0.0.1

Composable pass-fail check primitives for RustUse
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

//! Pass/fail check primitives.

pub mod prelude;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum CheckResult {
    Pass,
    Fail,
}

impl CheckResult {
    #[must_use]
    pub const fn from_bool(condition: bool) -> Self {
        if condition { Self::Pass } else { Self::Fail }
    }

    #[must_use]
    pub const fn is_pass(self) -> bool {
        matches!(self, Self::Pass)
    }

    #[must_use]
    pub const fn is_fail(self) -> bool {
        matches!(self, Self::Fail)
    }
}

#[must_use]
pub const fn check(condition: bool) -> CheckResult {
    CheckResult::from_bool(condition)
}

#[must_use]
pub const fn pass() -> CheckResult {
    CheckResult::Pass
}

#[must_use]
pub const fn fail() -> CheckResult {
    CheckResult::Fail
}

#[cfg(test)]
mod tests {
    use super::{check, fail, pass};

    #[test]
    fn constructors_match_boolean_intent() {
        assert!(check(true).is_pass());
        assert!(pass().is_pass());
        assert!(fail().is_fail());
    }
}