ExponentialBackoff

Struct ExponentialBackoff 

Source
pub struct ExponentialBackoff {
    pub initial_delay: Duration,
    pub max_delay: Duration,
    pub max_attempts: u32,
    pub multiplier: f64,
}
Expand description

Exponential backoff retry policy.

Each retry waits exponentially longer than the previous one, up to a maximum delay. This is the recommended policy for most network operations.

§Example

use error_rail::async_ext::ExponentialBackoff;
use core::time::Duration;

let policy = ExponentialBackoff {
    initial_delay: Duration::from_millis(100),
    max_delay: Duration::from_secs(10),
    max_attempts: 5,
    multiplier: 2.0,
};

// Delays: 100ms, 200ms, 400ms, 800ms, 1600ms (capped at 10s)

Fields§

§initial_delay: Duration

Initial delay before first retry.

§max_delay: Duration

Maximum delay between retries.

§max_attempts: u32

Maximum number of retry attempts.

§multiplier: f64

Multiplier applied to delay after each attempt.

Implementations§

Source§

impl ExponentialBackoff

Source

pub const fn new() -> Self

Creates a new exponential backoff policy with default settings.

The default configuration provides:

  • Initial delay: 100 milliseconds
  • Maximum delay: 30 seconds
  • Maximum attempts: 5
  • Multiplier: 2.0
Source

pub const fn with_initial_delay(self, delay: Duration) -> Self

Sets the initial delay duration for the first retry attempt.

This serves as the base value for the exponential calculation.

Source

pub const fn with_max_delay(self, delay: Duration) -> Self

Sets the maximum duration allowed between retry attempts.

The delay will never exceed this value regardless of the number of attempts or the multiplier.

Source

pub const fn with_max_attempts(self, attempts: u32) -> Self

Sets the maximum number of retry attempts allowed.

Once this number of retries is reached, the policy will stop suggesting delays.

Source

pub const fn with_multiplier(self, multiplier: f64) -> Self

Sets the multiplier applied to the delay after each failed attempt.

For example, a multiplier of 2.0 doubles the delay duration each time.

Trait Implementations§

Source§

impl Clone for ExponentialBackoff

Source§

fn clone(&self) -> ExponentialBackoff

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 ExponentialBackoff

Source§

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

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

impl Default for ExponentialBackoff

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl RetryPolicy for ExponentialBackoff

Source§

fn next_delay(&mut self, attempt: u32) -> Option<Duration>

Returns the delay before the next retry attempt, or None to stop retrying. Read more
Source§

fn reset(&mut self)

Resets the policy to its initial state. Read more
Source§

impl Copy for ExponentialBackoff

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