Skip to main content

CircuitBreaker

Struct CircuitBreaker 

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

Per-backend circuit breaker.

§Concurrency

CircuitBreaker is not Sync on its own — wrap it in a Mutex for shared use across threads (see global()).

Implementations§

Source§

impl CircuitBreaker

Source

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

Create a new circuit breaker.

  • failure_threshold — how many consecutive failures open the circuit.
  • recovery_secs — how long the circuit stays Open before testing again.

Defaults to letting exactly one probe through while HalfOpen — see CircuitBreaker::max_half_open_probes to change that.

Source

pub fn max_half_open_probes(self, n: u32) -> Self

Override how many concurrent probe requests are let through while a backend is HalfOpen (default: 1). Chainable — call before the breaker is put behind a shared Mutex/Arc.

Source

pub fn is_available(&mut self, backend: &str) -> bool

Returns true if a request should be forwarded to backend.

Transitions Open → HalfOpen when the recovery window has elapsed. While HalfOpen, at most max_half_open_probes concurrent calls return true — further calls are rejected like Open until the in-flight probe(s) resolve via record_success/record_failure.

Source

pub fn record_success(&mut self, backend: &str)

Record a successful response for backend.

Transitions HalfOpen → Closed and resets the failure counter and the in-flight half-open probe count.

Source

pub fn record_failure(&mut self, backend: &str)

Record a failed response for backend.

In Closed state, increments the counter and opens the circuit when failure_threshold is reached. In HalfOpen state, immediately re-opens the circuit and resets the recovery timer.

Source

pub fn reset(&mut self, backend: &str)

Reset backend to Closed with zero failures.

Source

pub fn state(&self, backend: &str) -> BreakerState

Return the current state for backend (defaults to Closed if unseen).

Source

pub fn all_states(&self) -> Vec<(String, BreakerState)>

Snapshot of every backend this breaker has ever seen, with its current state. Powers the rws_circuit_breaker_state{backend} metric (crate::metrics::prometheus_text) — there is no RedisCircuitBreaker equivalent, since enumerating keys isn’t something the minimal hand-rolled RESP client supports (no SCAN/KEYS array-reply decoding).

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more