Skip to main content

CircuitBreakerConfig

Struct CircuitBreakerConfig 

Source
pub struct CircuitBreakerConfig {
    pub failure_threshold: u32,
    pub reset_timeout: Duration,
    pub success_threshold: u32,
}
Expand description

Circuit breaker configuration.

§Example

use ccxt_core::circuit_breaker::CircuitBreakerConfig;
use std::time::Duration;

let config = CircuitBreakerConfig {
    failure_threshold: 5,
    reset_timeout: Duration::from_secs(30),
    success_threshold: 1,
};

Fields§

§failure_threshold: u32

Number of consecutive failures before opening the circuit.

When the failure count reaches this threshold, the circuit transitions from Closed to Open state.

Default: 5

§reset_timeout: Duration

Time to wait in Open state before transitioning to HalfOpen.

After this duration elapses, the circuit breaker will allow a test request to check if the service has recovered.

Default: 30 seconds

§success_threshold: u32

Number of consecutive successes needed to close the circuit from HalfOpen.

When in HalfOpen state, this many successful requests are required before transitioning back to Closed state.

Default: 1

Implementations§

Source§

impl CircuitBreakerConfig

Source

pub fn new( failure_threshold: u32, reset_timeout: Duration, success_threshold: u32, ) -> CircuitBreakerConfig

Creates a new circuit breaker configuration with the given parameters.

§Arguments
  • failure_threshold - Number of failures before opening the circuit
  • reset_timeout - Time to wait before testing recovery
  • success_threshold - Number of successes needed to close the circuit
Source

pub fn validate(&self) -> Result<ValidationResult, ConfigValidationError>

Validates the circuit breaker configuration.

§Returns

Returns Ok(ValidationResult) if the configuration is valid. Returns Err(ConfigValidationError) if the configuration is invalid.

§Validation Rules
  • failure_threshold must be > 0
  • success_threshold must be > 0
  • reset_timeout must be >= 1 second
§Example
use ccxt_core::circuit_breaker::CircuitBreakerConfig;

let config = CircuitBreakerConfig::default();
assert!(config.validate().is_ok());

Trait Implementations§

Source§

impl Clone for CircuitBreakerConfig

Source§

fn clone(&self) -> CircuitBreakerConfig

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 CircuitBreakerConfig

Source§

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

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

impl Default for CircuitBreakerConfig

Source§

fn default() -> CircuitBreakerConfig

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

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