rskit-component 0.2.0-alpha.1

Component lifecycle primitives: Component trait, Registry, Health, and State
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

use std::fmt;

/// Lifecycle state tracked for each registered component.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum State {
    /// The component has been registered but not started.
    Created,
    /// The component is currently starting.
    Starting,
    /// The component is running.
    Running,
    /// The component is currently stopping.
    Stopping,
    /// The component has stopped cleanly.
    Stopped,
    /// The component failed to start or stop cleanly.
    Failed,
}

impl fmt::Display for State {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Created => f.write_str("created"),
            Self::Starting => f.write_str("starting"),
            Self::Running => f.write_str("running"),
            Self::Stopping => f.write_str("stopping"),
            Self::Stopped => f.write_str("stopped"),
            Self::Failed => f.write_str("failed"),
        }
    }
}

impl State {
    pub(crate) const fn can_start(self) -> bool {
        matches!(self, Self::Created | Self::Stopped | Self::Failed)
    }

    pub(crate) const fn should_stop(self) -> bool {
        matches!(self, Self::Running)
    }
}

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

    #[test]
    fn display_matches_expected_values() {
        assert_eq!(State::Created.to_string(), "created");
        assert_eq!(State::Starting.to_string(), "starting");
        assert_eq!(State::Running.to_string(), "running");
        assert_eq!(State::Stopping.to_string(), "stopping");
        assert_eq!(State::Stopped.to_string(), "stopped");
        assert_eq!(State::Failed.to_string(), "failed");
    }
}