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

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

use crate::RecoveryInfo;

/// An evaluated execution result.
///
/// From the perspective of a circuit breaker, an execution can either
/// succeed or fail. This enum captures that binary outcome.
#[derive(Debug, PartialEq, Copy, Clone)]
pub(crate) enum ExecutionResult {
    Success,
    Failure,
}

#[cfg(any(feature = "logs", feature = "metrics", test))]
impl ExecutionResult {
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Success => "success",
            Self::Failure => "failure",
        }
    }
}

impl ExecutionResult {
    pub fn from_recovery(recovery: &RecoveryInfo) -> Self {
        match recovery.kind() {
            crate::RecoveryKind::Retry | crate::RecoveryKind::Unavailable => Self::Failure,
            _ => Self::Success,
        }
    }
}

#[cfg_attr(coverage_nightly, coverage(off))]
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_execution_result_from_recovery() {
        assert_eq!(ExecutionResult::from_recovery(&RecoveryInfo::retry()), ExecutionResult::Failure);
        assert_eq!(
            ExecutionResult::from_recovery(&RecoveryInfo::unavailable()),
            ExecutionResult::Failure
        );
        assert_eq!(ExecutionResult::from_recovery(&RecoveryInfo::never()), ExecutionResult::Success);
        assert_eq!(ExecutionResult::from_recovery(&RecoveryInfo::unknown()), ExecutionResult::Success);
    }

    #[test]
    fn test_execution_result_as_str() {
        assert_eq!(ExecutionResult::Success.as_str(), "success");
        assert_eq!(ExecutionResult::Failure.as_str(), "failure");
    }
}