use-event-status 0.1.0

Event status labels for RustUse event primitives.
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

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

use core::fmt;

#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum EventStatus {
    #[default]
    Pending,
    Emitted,
    Received,
    Handled,
    Ignored,
    Failed,
}

impl EventStatus {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Pending => "pending",
            Self::Emitted => "emitted",
            Self::Received => "received",
            Self::Handled => "handled",
            Self::Ignored => "ignored",
            Self::Failed => "failed",
        }
    }

    pub const fn is_terminal(self) -> bool {
        matches!(self, Self::Handled | Self::Ignored | Self::Failed)
    }

    pub const fn is_failure(self) -> bool {
        matches!(self, Self::Failed)
    }
}

impl fmt::Display for EventStatus {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str((*self).as_str())
    }
}

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

    #[test]
    fn exposes_status_labels() {
        assert_eq!(EventStatus::Pending.as_str(), "pending");
        assert_eq!(EventStatus::Handled.to_string(), "handled");
    }

    #[test]
    fn identifies_terminal_statuses() {
        assert!(!EventStatus::Pending.is_terminal());
        assert!(EventStatus::Handled.is_terminal());
        assert!(EventStatus::Ignored.is_terminal());
        assert!(EventStatus::Failed.is_terminal());
    }

    #[test]
    fn identifies_failure_status() {
        assert!(!EventStatus::Handled.is_failure());
        assert!(EventStatus::Failed.is_failure());
    }
}