Struct ExponentialBackoff

#[non_exhaustive]
pub struct ExponentialBackoff {
    pub max_n_retries: Option<u32>,
    pub min_retry_interval: Duration,
    pub max_retry_interval: Duration,
    pub jitter: Jitter,
    pub base: u32,
}

Exponential backoff with optional jitter.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_n_retries: Option<u32>

Maximum number of allowed retries attempts.

min_retry_interval: Duration

Minimum waiting time between two retry attempts (it can end up being lower when using full jitter).

max_retry_interval: Duration

Maximum waiting time between two retry attempts.

jitter: Jitter

How we apply jitter to the calculated backoff intervals.

base: u32

Base of the exponential

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_max_retries(5);

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, Some(5));
assert_eq!(backoff.base, 2);

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, _request_start_time: SystemTime, 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