Skip to main content

CircuitBreaker

Struct CircuitBreaker 

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

Circuit breaker for a module.

Implementations§

Source§

impl CircuitBreaker

Source

pub fn new(module_name: String, config: CircuitConfig) -> Self

Creates a new circuit breaker.

Source

pub fn with_defaults(module_name: String) -> Self

Creates a circuit breaker with default configuration.

Source

pub fn can_execute(&self) -> bool

Checks if a request can proceed.

Source

pub fn record_success(&self)

Records a successful call.

Source

pub fn record_failure(&self)

Records a failed call.

Source

pub fn state(&self) -> CircuitState

Returns the current state.

Source

pub fn stats(&self) -> CircuitStats

Returns statistics.

Source

pub fn module_name(&self) -> &str

Returns the module name.

Source

pub fn force_open(&self)

Forces the circuit to open (for testing/manual intervention).

Source

pub fn force_close(&self)

Forces the circuit to close (for testing/manual intervention).

Source

pub fn reset(&self)

Resets all counters.

Trait Implementations§

Source§

impl Debug for CircuitBreaker

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> 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> 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, 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.