use-event-kind 0.1.0

Event kind 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

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

use core::fmt;

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum EventKind {
    Created,
    Updated,
    Deleted,
    Started,
    Finished,
    Failed,
    Received,
    Emitted,
    Custom(String),
}

impl EventKind {
    pub fn custom(value: impl Into<String>) -> Self {
        Self::Custom(value.into())
    }

    pub fn as_str(&self) -> &str {
        match self {
            Self::Created => "created",
            Self::Updated => "updated",
            Self::Deleted => "deleted",
            Self::Started => "started",
            Self::Finished => "finished",
            Self::Failed => "failed",
            Self::Received => "received",
            Self::Emitted => "emitted",
            Self::Custom(value) => value.as_str(),
        }
    }
}

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

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

    #[test]
    fn exposes_standard_kind_labels() {
        assert_eq!(EventKind::Created.as_str(), "created");
        assert_eq!(EventKind::Started.to_string(), "started");
        assert_eq!(EventKind::Failed.as_str(), "failed");
    }

    #[test]
    fn supports_custom_kind_labels() {
        let kind = EventKind::custom("checkpoint");

        assert_eq!(kind.as_str(), "checkpoint");
        assert_eq!(kind.to_string(), "checkpoint");
    }
}