Struct ExponentialBackoff

pub struct ExponentialBackoff<F, R = HasherRng> { /* private fields */ }

A jittered exponential backoff strategy.

The backoff duration will increase exponentially for every subsequent backoff, up to a maximum duration. A small amount of random jitter is added to each backoff duration, in order to avoid retry spikes.

Implementations

impl<F, R> ExponentialBackoff<F, R>

where R: Rng + Clone, F: Fn() -> R + Clone,

pub fn new( min: Duration, max: Duration, jitter: f64, rng_creator: F, ) -> Result<Self, InvalidBackoff>

Create a new ExponentialBackoff.

Error

Returns a config validation error if:

• min > max
• max == 0
• jitter < 0.0
• jitter > 100.0
• jitter is not finite

Trait Implementations

impl<F, R> Backoff for ExponentialBackoff<F, R>

where R: Rng, F: Send + Sync + 'static,

async fn next_backoff(&self) -> bool

Initiate the next backoff in the sequence. Return false in case no backoff is possible anymore (e.g. max retries).

async fn reset(&self)

Reset the backoff to its initial state.

impl Clone for ExponentialBackoff<(), HasherRng>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F, R> Clone for ExponentialBackoff<F, R>

where R: Rng + Clone, F: Fn() -> R + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug, R: Debug> Debug for ExponentialBackoff<F, R>

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

Formats the value using the given formatter.

impl Default for ExponentialBackoff<(), HasherRng>

fn default() -> Self

Returns the “default value” for a type.