Struct KeyedCircuitBreaker 

pub struct KeyedCircuitBreaker<K: Hash + Eq + Clone + Send + Sync + 'static> { /* private fields */ }

Available on crate feature resilience only.

Generic keyed circuit breaker for per-resource isolation.

Unlike CircuitBreakerManager which uses String keys, this supports any hashable key type. Each key maintains independent circuit breaker state, allowing failures in one resource (e.g., one exchange, one endpoint) to not affect others.

Example

use allframe_core::resilience::{KeyedCircuitBreaker, CircuitBreakerConfig};

// Per-exchange circuit breakers for a trading system
let cb = KeyedCircuitBreaker::<String>::new(CircuitBreakerConfig::default());

// Check if we can make a request to Kraken
if cb.check(&"kraken".to_string()).is_ok() {
    // Make request...
    cb.record_success(&"kraken".to_string());
}

// Failures on Kraken don't affect Binance
cb.record_failure(&"kraken".to_string());
assert!(cb.check(&"binance".to_string()).is_ok());

Implementations

impl<K: Hash + Eq + Clone + Send + Sync + 'static> KeyedCircuitBreaker<K>

pub fn new(config: CircuitBreakerConfig) -> Self

Create a new keyed circuit breaker with the given configuration.

All keys will use the same circuit breaker configuration.

pub fn check(&self, key: &K) -> Result<(), CircuitOpenError>

Check if a request for the given key is allowed.

Returns Ok(()) if allowed, Err(CircuitOpenError) if the circuit is open.

pub fn record_success(&self, key: &K)

Record a successful request for the given key.

pub fn record_failure(&self, key: &K)

Record a failed request for the given key.

pub async fn call<F, Fut, T, E>( &self, key: &K, f: F, ) -> Result<T, CircuitBreakerError<E>>

where F: FnOnce() -> Fut, Fut: Future<Output = Result<T, E>>,

Execute an async operation through the circuit breaker for the given key.

pub fn get_state(&self, key: &K) -> Option<CircuitState>

Get the current state for a key.

pub fn get_stats(&self, key: &K) -> Option<CircuitBreakerStats>

Get statistics for a specific key.

pub fn get_all_stats(&self) -> Vec<(K, CircuitBreakerStats)>

Get statistics for all keys.

pub fn reset(&self, key: &K)

Reset a specific circuit breaker.

pub fn reset_all(&self)

Reset all circuit breakers.

pub fn remove(&self, key: &K)

Remove a circuit breaker for a key.

pub fn clear(&self)

Clear all circuit breakers.

pub fn len(&self) -> usize

Get the number of active circuit breakers.

pub fn is_empty(&self) -> bool

Check if there are no circuit breakers.

pub fn get(&self, key: &K) -> Option<Arc<CircuitBreaker>>

Get the underlying circuit breaker for a key, if it exists.

Trait Implementations

impl<K: Hash + Eq + Clone + Send + Sync + 'static> Default for KeyedCircuitBreaker<K>

fn default() -> Self

Returns the “default value” for a type.