Struct CircuitBreakerState 

pub struct CircuitBreakerState { /* private fields */ }

Runtime state of a circuit breaker

Tracks the current state (Closed/Open/HalfOpen) and failure count for a single node’s circuit breaker.

Implementations

impl CircuitBreakerState

pub const fn new() -> Self

Create a new circuit breaker in closed state

pub fn should_allow(&mut self, config: &CircuitBreakerConfig) -> bool

Check if the circuit allows execution

Returns true if the node should be allowed to execute. Returns false if the circuit is open and the cooldown has not elapsed.

This method does NOT consume half-open probe budget. Call mark_half_open_attempt after the task actually executes to consume the probe budget.

pub fn mark_half_open_attempt(&mut self)

Consume a half-open probe attempt after actual execution

Call this after a task actually executes (success or failure) in HalfOpen state to consume the probe budget. This ensures the budget is consumed by executions, not eligibility checks.

pub fn record_success(&mut self)

Record a successful execution

Resets the circuit to Closed state. If the circuit is currently Open, this is a no-op (success cannot be recorded for an Open circuit because no execution is allowed).

pub fn record_failure(&mut self, config: &CircuitBreakerConfig)

Record a failed execution

pub const fn state(&self) -> &CircuitState

Get the current circuit state

pub const fn consecutive_failures(&self) -> usize

Get the number of consecutive failures

Trait Implementations

impl Clone for CircuitBreakerState

fn clone(&self) -> CircuitBreakerState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircuitBreakerState

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

Formats the value using the given formatter.

impl Default for CircuitBreakerState

fn default() -> Self

Returns the “default value” for a type.