Struct ExponentialRetryOptions

pub struct ExponentialRetryOptions {
    pub initial_delay: Duration,
    pub max_retries: u32,
    pub max_total_elapsed: Duration,
    pub max_delay: Duration,
}

Options for how an exponential retry strategy should behave.

Example

Configuring retry to be exponential with 10 retries max and an initial delay of 1 second.

RetryOptions::exponential(
   ExponentialRetryOptions::default()
       .max_retries(10u32)
       .initial_delay(Duration::from_secs(1)),
);

Fields

initial_delay: Duration

The initial delay between retry attempts. The delay will increase with each retry.

The default is 200 milliseconds.

max_retries: u32

The maximum number of retry attempts before giving up.

The default is 8.

max_total_elapsed: Duration

The maximum permissible elapsed time since starting to retry before giving up.

The default is 1 minute.

max_delay: Duration

The maximum permissible time between retries.

The default is 30 seconds. For SRE reasons, this is only respected when above 1 second.

Implementations

impl ExponentialRetryOptions

pub fn initial_delay<P: Into<Duration>>(self, initial_delay: P) -> Self

pub fn max_retries<P: Into<u32>>(self, max_retries: P) -> Self

pub fn max_total_elapsed<P: Into<Duration>>(self, max_total_elapsed: P) -> Self

pub fn max_delay<P: Into<Duration>>(self, max_delay: P) -> Self

Trait Implementations

impl Clone for ExponentialRetryOptions

fn clone(&self) -> ExponentialRetryOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExponentialRetryOptions

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

Formats the value using the given formatter.

impl Default for ExponentialRetryOptions

fn default() -> Self

Returns the “default value” for a type.