Enum Trip 

#[non_exhaustive]
pub enum Trip {
    Consecutive(u32),
    Ratio {
        window: u32,
        ratio: f64,
        min_calls: u32,
    },
    Windowed {
        failures: u32,
        period: Duration,
    },
}

Available on crate feature circuit-breaker only.

The condition under which a closed breaker trips open.

#[non_exhaustive]: more trip conditions may be added.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Consecutive(u32)

Trip after this many consecutive failures (a success resets the count).

Ratio

Trip when the failure ratio over the last window calls reaches ratio, once at least min_calls have been observed.

Fields

window: u32

How many recent calls to consider.

ratio: f64

The failure fraction in [0.0, 1.0] that trips the breaker.

min_calls: u32

The minimum calls before the ratio is evaluated.

Windowed

Trip when at least failures failures occur within a rolling period.

Fields

failures: u32

The failure count that trips the breaker.

period: Duration

The rolling time window the failures are counted in.

Trait Implementations

impl Clone for Trip

fn clone(&self) -> Trip

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Trip

impl Debug for Trip

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Trip

fn eq(&self, other: &Trip) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Trip