ooroo 0.3.0

A fast, compiled rule engine with a text-based DSL
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

use std::fmt;

/// The result of evaluating a [`RuleSet`](super::RuleSet) against a context.
///
/// Contains the name of the matched terminal and whether it evaluated to `true`.
#[derive(Debug, Clone, PartialEq, Eq)]
#[must_use]
pub struct Verdict {
    terminal: String,
    result: bool,
}

impl fmt::Display for Verdict {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} = {}", self.terminal, self.result)
    }
}

impl Verdict {
    /// Create a new verdict for the given terminal name and result.
    pub fn new(terminal: impl Into<String>, result: bool) -> Self {
        Self {
            terminal: terminal.into(),
            result,
        }
    }

    /// The name of the terminal that matched.
    #[must_use]
    pub fn terminal(&self) -> &str {
        &self.terminal
    }

    /// Whether the terminal's rule evaluated to `true`.
    #[must_use]
    pub fn result(&self) -> bool {
        self.result
    }
}

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

    #[test]
    fn new_verdict() {
        let v = Verdict::new("can_proceed", true);
        assert_eq!(v.terminal(), "can_proceed");
        assert!(v.result());
    }

    #[test]
    fn verdict_equality() {
        let v1 = Verdict::new("deny", false);
        let v2 = Verdict::new("deny", false);
        assert_eq!(v1, v2);
    }

    #[test]
    fn verdict_inequality() {
        let v1 = Verdict::new("allow", true);
        let v2 = Verdict::new("deny", true);
        assert_ne!(v1, v2);
    }
}