CircuitBreaker

Struct CircuitBreaker 

Source
pub struct CircuitBreaker { /* private fields */ }
Expand description

Circuit breaker for fault tolerance

The circuit breaker monitors failures and automatically transitions between states:

  • Closed: Normal operation, requests pass through
  • Open: Too many failures, requests are blocked
  • HalfOpen: Testing recovery, limited requests allowed

§Examples

use chie_shared::CircuitBreaker;

let mut breaker = CircuitBreaker::new(5, 60_000, 30_000);

// Record successful requests
breaker.record_success();
assert!(breaker.is_closed());

// Record failures
for _ in 0..5 {
    breaker.record_failure();
}
assert!(breaker.is_open());

Implementations§

Source§

impl CircuitBreaker

Source

pub fn new( failure_threshold: u32, timeout_ms: u64, half_open_timeout_ms: u64, ) -> Self

Create a new circuit breaker

§Arguments
  • failure_threshold - Number of failures before opening circuit
  • timeout_ms - Milliseconds to keep circuit open
  • half_open_timeout_ms - Milliseconds for half-open state
Source

pub fn with_defaults() -> Self

Create a circuit breaker with default settings

Defaults: 5 failures, 60s timeout, 30s half-open timeout

Source

pub fn state(&self) -> CircuitState

Get the current state

Source

pub fn is_closed(&self) -> bool

Check if circuit is closed (requests allowed)

Source

pub fn is_open(&self) -> bool

Check if circuit is open (requests blocked)

Source

pub fn is_half_open(&self) -> bool

Check if circuit is half-open (testing recovery)

Source

pub fn allow_request(&self) -> bool

Check if a request is allowed through the circuit

Source

pub fn record_success(&mut self)

Record a successful request

Source

pub fn record_failure(&mut self)

Record a failed request

Source

pub fn failure_count(&self) -> u32

Get failure count

Source

pub fn time_until_half_open(&self) -> Option<Duration>

Get time remaining until circuit can transition from open to half-open

Source

pub fn reset(&mut self)

Reset the circuit breaker to closed state

Source

pub fn force_open(&mut self)

Force circuit to open state

Trait Implementations§

Source§

impl Clone for CircuitBreaker

Source§

fn clone(&self) -> CircuitBreaker

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CircuitBreaker

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CircuitBreaker

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.