Struct CircuitBreaker 

pub struct CircuitBreaker { /* private fields */ }

A circuit breaker. Cheap to clone; the inner state is Arc<Mutex<_>>.

Implementations

impl CircuitBreaker

pub fn new() -> Self

Default-configured breaker.

pub fn builder() -> CircuitBreakerBuilder

Start configuring a new breaker.

pub async fn state(&self) -> CircuitState

Current breaker state. Mostly for telemetry / tests.

pub async fn call<F, T, E>(&self, fut: F) -> Result<Result<T, E>, ToolkitError>

where F: Future<Output = Result<T, E>>,

Execute fut, gating it on the breaker state.

Returns:

• Ok(Ok(value)) — call ran and succeeded.
• Ok(Err(e)) — call ran and the wrapped future returned Err(e). The breaker counts this as a failure.
• Err(ToolkitError::CircuitOpen { .. }) — call was rejected without being invoked.

pub async fn trip(&self)

Manually trip the breaker open. Useful for kill-switches.

pub async fn reset(&self)

Manually reset the breaker to closed. Useful after a known-good deploy.

Trait Implementations

impl Clone for CircuitBreaker

fn clone(&self) -> CircuitBreaker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircuitBreaker

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

Formats the value using the given formatter.

impl Default for CircuitBreaker

fn default() -> Self

Returns the “default value” for a type.