Struct CircuitBreaker 

pub struct CircuitBreaker { /* private fields */ }

Circuit Breaker

Thread-safe, can be shared across multiple async tasks (Arc<CircuitBreaker>).

Implementations

impl CircuitBreaker

pub fn new(config: CircuitBreakerConfig) -> CircuitBreaker

Create a circuit breaker with an explicit configuration.

pub fn default_config() -> CircuitBreaker

Create a circuit breaker with default configuration.

pub fn is_open(&self) -> bool

Pure query: check whether currently in Open state (does not change any state).

For monitoring and logging only; does not trigger state transitions.

pub fn try_advance(&self) -> bool

Attempt to advance state: if Open and timeout has elapsed, transition to HalfOpen automatically.

Returns true if the request should be rejected (still in Open state), returns false if processing may proceed (Closed or HalfOpen).

In HalfOpen state, at most 1 probe request is allowed concurrently, avoiding thundering herd during recovery.

Callers should invoke record_success() or record_failure() after the request completes, which will automatically release the probe quota. If the request is rejected, callers should invoke record_rejected() to update statistics.

pub fn record_rejected(&self)

Record a rejected request (while in Open state).

pub fn rejected_count(&self) -> u32

Get the total number of rejected requests (for monitoring).

pub fn record_success(&self)

Record a successful call.

pub fn record_failure(&self)

Record a failed call.

pub fn state_name(&self) -> &'static str

Get a human-readable description of the current state (for logging/monitoring).

pub fn consecutive_failures(&self) -> u32

Get the current consecutive failure count (meaningful only in Closed state).

Trait Implementations

impl Debug for CircuitBreaker

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

Formats the value using the given formatter.