Type Alias ExponentialBackoff

pub type ExponentialBackoff = ExponentialBackoff<SystemClock>;

Exponential backoff policy with system’s clock.

This type is preferred over exponential::ExponentialBackoff as it is generic over any Clocks and in the real world mostly system’s clock is used.

Aliased Type

struct ExponentialBackoff {
    pub current_interval: Duration,
    pub initial_interval: Duration,
    pub randomization_factor: f64,
    pub multiplier: f64,
    pub max_interval: Duration,
    pub start_time: Instant,
    pub max_elapsed_time: Option<Duration>,
    pub clock: SystemClock,
}

Fields

current_interval: Duration

The current retry interval.

initial_interval: Duration

The initial retry interval.

randomization_factor: f64

The randomization factor to use for creating a range around the retry interval.

A randomization factor of 0.5 results in a random period ranging between 50% below and 50% above the retry interval.

multiplier: f64

The value to multiply the current interval with for each retry attempt.

max_interval: Duration

The maximum value of the back off period. Once the retry interval reaches this value it stops increasing.

start_time: Instant

The system time. It is calculated when an ExponentialBackoff instance is created and is reset when retry is called.

max_elapsed_time: Option<Duration>

The maximum elapsed time after instantiating ExponentialBackfff or calling reset after which next_backoff returns None.

clock: SystemClock

The clock used to get the current time.

Implementations

impl<C: Clock> ExponentialBackoff<C>

pub fn get_elapsed_time(&self) -> Duration

Returns the elapsed time since start_time.

Trait Implementations

impl<C> Backoff for ExponentialBackoff<C>

where C: Clock,

fn reset(&mut self)

Resets the internal state to the initial value.

fn next_backoff(&mut self) -> Option<Duration>

next_backoff() time is elapsed before it is called again. If it returns None, it means the operation timed out and no further retries are done.

impl<C> Clone for ExponentialBackoff<C>

where C: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug> Debug for ExponentialBackoff<C>

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

Formats the value using the given formatter.

impl<C> Default for ExponentialBackoff<C>

where C: Clock + Default,

fn default() -> ExponentialBackoff<C>

Returns the “default value” for a type.