BackoffStrategy

Struct BackoffStrategy 

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

Calculates retry delay with exponential backoff and jitter.

The backoff strategy uses the formula: min(base_delay * multiplier^attempt, max_delay) + jitter

Where jitter is a random value in the range [0, delay * jitter_factor].

§Example

use ccxt_core::ws_client::{BackoffConfig, BackoffStrategy};

let strategy = BackoffStrategy::new(BackoffConfig::default());

// First attempt (attempt = 0): ~1 second + jitter
let delay0 = strategy.calculate_delay(0);

// Second attempt (attempt = 1): ~2 seconds + jitter
let delay1 = strategy.calculate_delay(1);

// Third attempt (attempt = 2): ~4 seconds + jitter
let delay2 = strategy.calculate_delay(2);

Implementations§

Source§

impl BackoffStrategy

Source

pub fn new(config: BackoffConfig) -> BackoffStrategy

Creates a new backoff strategy with the given configuration.

§Arguments
  • config - The backoff configuration to use
Source

pub fn with_defaults() -> BackoffStrategy

Creates a new backoff strategy with default configuration.

Source

pub fn config(&self) -> &BackoffConfig

Returns a reference to the underlying configuration.

Source

pub fn calculate_delay(&self, attempt: u32) -> Duration

Calculates delay for the given attempt number.

Formula: min(base_delay * multiplier^attempt, max_delay) + jitter

§Arguments
  • attempt - The attempt number (0-indexed)
§Returns

The calculated delay duration including jitter.

§Example
use ccxt_core::ws_client::{BackoffConfig, BackoffStrategy};
use std::time::Duration;

let config = BackoffConfig {
    base_delay: Duration::from_secs(1),
    max_delay: Duration::from_secs(60),
    jitter_factor: 0.0, // No jitter for predictable results
    multiplier: 2.0,
};
let strategy = BackoffStrategy::new(config);

// With no jitter, delays are exactly: 1s, 2s, 4s, 8s, ...
assert_eq!(strategy.calculate_delay(0), Duration::from_secs(1));
assert_eq!(strategy.calculate_delay(1), Duration::from_secs(2));
assert_eq!(strategy.calculate_delay(2), Duration::from_secs(4));
Source

pub fn calculate_delay_without_jitter(&self, attempt: u32) -> Duration

Calculates the base delay (without jitter) for the given attempt number.

This is useful for testing or when you need predictable delay values.

§Arguments
  • attempt - The attempt number (0-indexed)
§Returns

The calculated delay duration without jitter.

Trait Implementations§

Source§

impl Clone for BackoffStrategy

Source§

fn clone(&self) -> BackoffStrategy

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 BackoffStrategy

Source§

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

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