Struct RiCircuitBreaker 

pub struct RiCircuitBreaker { /* private fields */ }

Basic circuit breaker implementation.

This struct provides a thread-safe circuit breaker that protects against cascading failures by monitoring the success and failure patterns of operations and transitioning between states (Closed, Open, HalfOpen) based on configurable thresholds.

Implementations

impl RiCircuitBreaker

pub fn new(config: RiCircuitBreakerConfig) -> Self

Creates a new circuit breaker with the specified configuration.

Parameters

• config: The configuration for the circuit breaker behavior

Returns

A new RiCircuitBreaker instance

pub fn allow_request(&self) -> bool

Determines if a request should be allowed to proceed based on the current circuit breaker state.

• Closed: Always allows requests
• Open: Rejects requests unless timeout has elapsed, then transitions to HalfOpen
• HalfOpen: Allows limited requests to test service health

Returns

true if the request should be allowed, false otherwise

pub fn record_success(&self)

Records a successful operation and updates the circuit breaker state if necessary.

pub fn record_failure(&self)

Records a failed operation and updates the circuit breaker state if necessary.

pub async fn execute<F, R>(&self, operation: F) -> RiResult<R>

where F: Future<Output = RiResult<R>>,

Executes an operation with circuit breaker protection.

This method wraps an async operation and automatically handles success/failure recording and state transitions based on the operation’s result.

Type Parameters

• F: The async future type representing the operation
• R: The result type of the operation

Parameters

• operation: The async operation to execute with circuit breaker protection

Returns

The result of the operation, or an error if the circuit breaker is open

pub fn get_state(&self) -> RiCircuitBreakerState

Gets the current state of the circuit breaker.

Returns

The current RiCircuitBreakerState (Closed, Open, or HalfOpen)

pub fn get_stats(&self) -> RiCircuitBreakerMetrics

Gets the current metrics for the circuit breaker.

Returns

A RiCircuitBreakerMetrics struct containing the current statistics

pub fn get_config(&self) -> RiCircuitBreakerConfig

Gets the configuration for the circuit breaker.

Returns

A reference to the RiCircuitBreakerConfig used by this circuit breaker

pub fn reset(&self)

Resets the circuit breaker to its initial state (Closed).

This method resets all counters and transitions the circuit breaker to Closed state.

pub fn force_open(&self)

Forces the circuit breaker to transition to Open state.

This method immediately opens the circuit breaker, rejecting all requests until the timeout elapses.

pub fn force_close(&self)

Forces the circuit breaker to transition to Closed state.

This method immediately closes the circuit breaker, allowing all requests to proceed.

pub fn failure_rate(&self) -> f64

pub fn success_rate(&self) -> f64

pub fn total_requests(&self) -> usize

pub fn is_open(&self) -> bool

pub fn is_closed(&self) -> bool

pub fn is_half_open(&self) -> bool

Trait Implementations

impl<'py> IntoPyObject<'py> for RiCircuitBreaker

type Target = RiCircuitBreaker

The Python output type

type Output = Bound<'py, <RiCircuitBreaker as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiCircuitBreaker

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiCircuitBreaker

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// (Closed, Open, HalfOpen) based on configurable thresholds.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiCircuitBreaker>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyTypeInfo for RiCircuitBreaker

const NAME: &'static str = "RiCircuitBreaker"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for RiCircuitBreaker

impl ExtractPyClassWithClone for RiCircuitBreaker