Struct CircuitBreaker 

pub struct CircuitBreaker { /* private fields */ }

A RetryPolicy that stops retrying after threshold consecutive failures and stays silent for a cooldown window before resetting.

States

• Closed (normal): forwards calls, increments a failure counter on each error, and applies an exponential back-off up to threshold − 1 attempts. On the threshold-th consecutive failure the breaker trips.
• Open (tripped): rejects every call immediately (Break) for the duration of cooldown.
• Reset: once cooldown has elapsed the breaker closes again and the failure counter resets to zero.

Because RetryPolicy has no success callback the breaker cannot distinguish a successful probe from a clean run; the counter simply resets when the cooldown expires. For a full half-open probe you can wrap CircuitBreaker in a custom RetryPolicy.

Example

use ferogram::retry::CircuitBreaker;
use std::time::Duration;

// Trip after 5 consecutive errors; stay open for 30 s.
let policy = CircuitBreaker::new(5, Duration::from_secs(30));

Implementations

impl CircuitBreaker

pub fn new(threshold: u32, cooldown: Duration) -> Self

Create a new CircuitBreaker.

• threshold: failures before the breaker trips (minimum 1).
• cooldown: how long the breaker stays open.

Trait Implementations

impl RetryPolicy for CircuitBreaker

fn should_retry(&self, _ctx: &RetryContext) -> ControlFlow<(), Duration>

Decide whether to retry the failed request.