seatbelt 0.4.2

Resilience and recovery mechanisms for fallible operations.
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

use std::time::Duration;

use tick::Clock;

use crate::breaker::BreakerId;

/// Arguments for the [`recovery_with`][super::BreakerLayer::recovery_with] callback function.
///
/// Provides context for recovery classification in the circuit breaker.
#[derive(Debug)]
#[non_exhaustive]
pub struct RecoveryArgs<'a> {
    pub(crate) breaker_id: &'a BreakerId,
    pub(crate) clock: &'a Clock,
}

impl RecoveryArgs<'_> {
    /// Returns the breaker ID associated with the recovery evaluation.
    #[must_use]
    pub fn breaker_id(&self) -> &BreakerId {
        self.breaker_id
    }

    /// Returns a reference to the clock use by the circuit breaker.
    #[must_use]
    pub fn clock(&self) -> &Clock {
        self.clock
    }
}

/// Arguments for the [`rejected_input`][super::BreakerLayer::rejected_input] callback function.
///
/// Provides context for generating outputs when the inputs are rejected by the circuit breaker.
#[derive(Debug)]
pub struct RejectedInputArgs<'a> {
    pub(crate) breaker_id: &'a BreakerId,
}

impl RejectedInputArgs<'_> {
    /// Returns the breaker ID associated with the rejected input.
    #[must_use]
    pub fn breaker_id(&self) -> &BreakerId {
        self.breaker_id
    }
}

/// Arguments for the [`on_probing`][super::BreakerLayer::on_probing] callback function.
///
/// Provides context when the circuit breaker enters the probing state to test if the service has recovered.
#[derive(Debug)]
#[non_exhaustive]
pub struct OnProbingArgs<'a> {
    pub(crate) breaker_id: &'a BreakerId,
}

impl OnProbingArgs<'_> {
    /// Returns the breaker ID associated with the probing execution.
    #[must_use]
    pub fn breaker_id(&self) -> &BreakerId {
        self.breaker_id
    }
}

/// Arguments for the [`on_closed`][super::BreakerLayer::on_closed] callback function.
///
/// Provides context when the circuit breaker transitions to the closed state, allowing normal operation.
#[derive(Debug)]
#[non_exhaustive]
pub struct OnClosedArgs<'a> {
    pub(crate) breaker_id: &'a BreakerId,
    pub(crate) open_duration: std::time::Duration,
}

impl OnClosedArgs<'_> {
    /// Returns the breaker ID associated with this event.
    #[must_use]
    pub fn breaker_id(&self) -> &BreakerId {
        self.breaker_id
    }

    /// Returns the duration the circuit was open before closing.
    #[must_use]
    pub fn open_duration(&self) -> Duration {
        self.open_duration
    }
}

/// Arguments for the [`on_opened`][super::BreakerLayer::on_opened] callback function.
///
/// Provides context when the circuit breaker transitions to the open state, blocking inputs due to failures.
#[derive(Debug)]
#[non_exhaustive]
pub struct OnOpenedArgs<'a> {
    pub(crate) breaker_id: &'a BreakerId,
}

impl OnOpenedArgs<'_> {
    /// Returns the breaker ID associated with this event.
    #[must_use]
    pub fn breaker_id(&self) -> &BreakerId {
        self.breaker_id
    }
}

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

    #[test]
    fn recovery_args_accessors() {
        let key = BreakerId::from("test");
        let clock = Clock::new_frozen();
        let args = RecoveryArgs {
            breaker_id: &key,
            clock: &clock,
        };
        assert_eq!(args.breaker_id(), &key);
        let _ = args.clock();
        assert!(format!("{args:?}").contains("RecoveryArgs"));
    }

    #[test]
    fn rejected_input_args_accessors() {
        let key = BreakerId::from("rejected");
        let args = RejectedInputArgs { breaker_id: &key };
        assert_eq!(args.breaker_id(), &key);
        assert!(format!("{args:?}").contains("RejectedInputArgs"));
    }

    #[test]
    fn on_probing_args_accessors() {
        let key = BreakerId::from("probing");
        let args = OnProbingArgs { breaker_id: &key };
        assert_eq!(args.breaker_id(), &key);
        assert!(format!("{args:?}").contains("OnProbingArgs"));
    }

    #[test]
    fn on_closed_args_accessors() {
        let key = BreakerId::from("closed");
        let duration = Duration::from_secs(5);
        let args = OnClosedArgs {
            breaker_id: &key,
            open_duration: duration,
        };
        assert_eq!(args.breaker_id(), &key);
        assert_eq!(args.open_duration(), duration);
        assert!(format!("{args:?}").contains("OnClosedArgs"));
    }

    #[test]
    fn on_opened_args_accessors() {
        let key = BreakerId::from("opened");
        let args = OnOpenedArgs { breaker_id: &key };
        assert_eq!(args.breaker_id(), &key);
        assert!(format!("{args:?}").contains("OnOpenedArgs"));
    }
}