failsafe 1.3.0

A circuit breaker implementation
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

use super::backoff;
use super::failure_policy::{self, ConsecutiveFailures, FailurePolicy, SuccessRateOverTimeWindow};
use super::instrument::Instrument;
use super::state_machine::StateMachine;

/// A `CircuitBreaker`'s configuration.
#[derive(Debug)]
pub struct Config<POLICY, INSTRUMENT> {
    pub(crate) failure_policy: POLICY,
    pub(crate) instrument: INSTRUMENT,
}

impl Config<(), ()> {
    /// Creates a new circuit breaker's default configuration.
    #[allow(clippy::new_ret_no_self)]
    pub fn new() -> Config<
        failure_policy::OrElse<
            SuccessRateOverTimeWindow<backoff::EqualJittered>,
            ConsecutiveFailures<backoff::EqualJittered>,
        >,
        (),
    > {
        let failure_policy =
            SuccessRateOverTimeWindow::default().or_else(ConsecutiveFailures::default());

        Config {
            failure_policy,
            instrument: (),
        }
    }
}

impl<POLICY, INSTRUMENT> Config<POLICY, INSTRUMENT> {
    /// Configures `FailurePolicy` for a circuit breaker.
    pub fn failure_policy<T>(self, failure_policy: T) -> Config<T, INSTRUMENT>
    where
        T: FailurePolicy,
    {
        Config {
            failure_policy,
            instrument: self.instrument,
        }
    }

    /// Configures `Instrument` for a circuit breaker.
    pub fn instrument<T>(self, instrument: T) -> Config<POLICY, T>
    where
        T: Instrument,
    {
        Config {
            failure_policy: self.failure_policy,
            instrument,
        }
    }

    /// Builds a new circuit breaker instance.
    pub fn build(self) -> StateMachine<POLICY, INSTRUMENT>
    where
        POLICY: FailurePolicy,
        INSTRUMENT: Instrument,
    {
        StateMachine::new(self.failure_policy, self.instrument)
    }
}