Skip to main content

NetworkCircuitBreaker

Struct NetworkCircuitBreaker 

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

Production-quality circuit breaker for network connections.

§Thread Safety

This type is deliberately not Send + Sync — wrap it in a Mutex or RwLock if you need shared mutable access from multiple threads or tasks.

§Timestamps

All current_ts parameters are in microseconds on a caller-supplied monotonic clock. The implementation never calls SystemTime or any other OS API for time.

Implementations§

Source§

impl NetworkCircuitBreaker

Source

pub fn new(config: CircuitConfig) -> Result<Self, BreakerError>

Create a new circuit breaker with the given configuration.

Returns a BreakerError::ConfigurationError if the configuration is logically inconsistent.

Source

pub fn call( &mut self, current_ts: u64, ) -> Result<CircuitCallGuard, BreakerError>

Try to acquire a call slot.

  • Closed → always succeeds.
  • Open → fails with BreakerError::CircuitOpen unless current_ts >= opened_at + retry_after_us, in which case the circuit automatically transitions to HalfOpen.
  • HalfOpen → succeeds if probe_count < half_open_probes, otherwise fails with BreakerError::MaxProbesExceeded.
Source

pub fn record_outcome( &mut self, outcome: CircuitOutcome, response_time_us: u64, current_ts: u64, ) -> Option<CircuitEvent>

Record the outcome of a permitted call and advance the state machine.

Returns a CircuitEvent if a notable state transition occurred.

response_time_us is the elapsed time in microseconds; it is used only for metrics and does not affect the state machine directly.

Source

pub fn force_open(&mut self, current_ts: u64)

Force the circuit into the Open state regardless of current state.

Source

pub fn force_close(&mut self)

Force the circuit into the Closed state regardless of current state.

Source

pub fn state(&self) -> &CircuitState

Return a reference to the current circuit state.

Source

pub fn reset_metrics(&mut self)

Reset all accumulated metrics (success/failure/rejection counters and response-time average). The state machine and event history are unaffected.

Source

pub fn metrics(&self, _current_ts: u64) -> CircuitMetrics

Return a point-in-time metrics snapshot.

Source

pub fn event_history(&self) -> Vec<CircuitEvent>

Return the last up-to-50 circuit events.

Trait Implementations§

Source§

impl Debug for NetworkCircuitBreaker

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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