Struct ExponentialBackoff

pub struct ExponentialBackoff {
    pub max_n_retries: u32,
    pub min_retry_interval: Duration,
    pub max_retry_interval: Duration,
    pub backoff_exponent: u32,
}

We are using the “decorrelated jitter” approach detailed here: <https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/>

Fields

max_n_retries: u32

Maximum number of allowed retries attempts.

min_retry_interval: Duration

Minimum waiting time between two retry attempts (it can end up being lower due to jittering).

max_retry_interval: Duration

Maximum waiting time between two retry attempts.

backoff_exponent: u32

Growing factor governing how fast the retry interval increases with respect to the number of failed attempts. If set to 3:

• first retry: 3^0 = 1
• second retry: 3^1 = 3
• third retry: 3^2 = 9 …

Implementations

impl ExponentialBackoff

pub fn builder() -> ExponentialBackoffBuilder

Returns a builder.

Example

use retry_policies::policies::ExponentialBackoff;
use std::time::Duration;

let backoff = ExponentialBackoff::builder()
    .build_with_total_retry_duration(Duration::from_secs(24 * 60 * 60));

assert_eq!(backoff.backoff_exponent, 3);
assert_eq!(backoff.min_retry_interval, Duration::from_secs(1));
assert_eq!(backoff.max_retry_interval, Duration::from_secs(30 * 60));
assert_eq!(backoff.max_n_retries, 55); // calculated

Trait Implementations

impl Clone for ExponentialBackoff

fn clone(&self) -> ExponentialBackoff

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExponentialBackoff

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

Formats the value using the given formatter.

impl PartialEq for ExponentialBackoff

fn eq(&self, other: &ExponentialBackoff) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RetryPolicy for ExponentialBackoff

fn should_retry(&self, n_past_retries: u32) -> RetryDecision

Determine if a task should be retried according to a retry policy.

impl Copy for ExponentialBackoff

impl Eq for ExponentialBackoff

impl StructuralPartialEq for ExponentialBackoff