Skip to main content

CircuitBreaker

Struct CircuitBreaker 

Source
pub struct CircuitBreaker { /* private fields */ }
Expand description

A thread-safe circuit breaker. Usage: before_call -> do work -> record_success / record_failure / record_abort.

Implementations§

Source§

impl CircuitBreaker

Source

pub fn new( config: BreakerConfig, clock: Option<Arc<dyn Clock>>, on_state_change: Option<Box<dyn Fn(BreakerState, BreakerState) + Send + Sync>>, ) -> Self

Builds a breaker. clock defaults to SystemClock when None.

Source

pub fn state(&self) -> BreakerState

The current state, refreshing Open -> HalfOpen if the recovery timeout elapsed.

Source

pub fn before_call(&self) -> Result<(), PoolError>

Returns PoolError::CircuitOpen if the call must not be attempted.

Source

pub fn record_success(&self)

Records a successful call.

Source

pub fn record_failure(&self)

Records a failed call.

Source

pub fn record_abort(&self)

Releases a half-open probe slot without counting it either way (the call was cancelled or timed out before the backend answered).

Source

pub fn call<F, R, E>(&self, f: F) -> Result<R, PoolError>
where F: FnOnce() -> Result<R, E>, PoolError: From<E>,

Convenience wrapper for an arbitrary fallible closure.

Source

pub fn reset(&self)

Forces the breaker back to Closed.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.