rskit-bootstrap 0.2.0-alpha.2

Application lifecycle orchestration: typestate App, Component registry, hooks
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! Bootstrap lifecycle phase metadata.

use rskit_hook::{Event, EventType};

/// Lifecycle phases emitted by bootstrap.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum LifecycleEventType {
    /// Emitted before components start.
    BeforeStart,
    /// Emitted after components start and readiness checks pass.
    AfterStart,
    /// Emitted before components stop.
    BeforeStop,
    /// Emitted after components stop.
    AfterStop,
}

impl LifecycleEventType {
    /// Return the stable lifecycle phase label.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::BeforeStart => "bootstrap:before_start",
            Self::AfterStart => "bootstrap:after_start",
            Self::BeforeStop => "bootstrap:before_stop",
            Self::AfterStop => "bootstrap:after_stop",
        }
    }
}

/// Lifecycle event metadata for observers.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct LifecycleEvent {
    kind: LifecycleEventType,
}

impl LifecycleEvent {
    /// Create a lifecycle event for the given phase.
    #[must_use]
    pub const fn new(kind: LifecycleEventType) -> Self {
        Self { kind }
    }

    /// Return the lifecycle phase.
    #[must_use]
    pub const fn kind(&self) -> LifecycleEventType {
        self.kind
    }
}

impl Event for LifecycleEvent {
    fn event_type(&self) -> EventType {
        EventType::new(self.kind.as_str())
    }
}

#[cfg(test)]
mod tests {
    use rskit_hook::Event as _;

    use super::*;

    #[test]
    fn lifecycle_event_types_expose_stable_labels_and_event_types() {
        assert_eq!(
            LifecycleEventType::BeforeStart.as_str(),
            "bootstrap:before_start"
        );
        assert_eq!(
            LifecycleEventType::AfterStart.as_str(),
            "bootstrap:after_start"
        );
        assert_eq!(
            LifecycleEventType::BeforeStop.as_str(),
            "bootstrap:before_stop"
        );
        assert_eq!(
            LifecycleEventType::AfterStop.as_str(),
            "bootstrap:after_stop"
        );

        let event = LifecycleEvent::new(LifecycleEventType::AfterStop);
        assert_eq!(event.kind(), LifecycleEventType::AfterStop);
        assert_eq!(event.event_type(), EventType::new("bootstrap:after_stop"));
    }
}