Enum RetryPolicy

pub enum RetryPolicy {
    Infinite,
    None,
    FixedDelay {
        interval: Duration,
        max_attempts: Option<u32>,
        max_duration: Option<Duration>,
    },
    Exponential {
        initial_interval: Duration,
        factor: f32,
        max_interval: Option<Duration>,
        max_attempts: Option<u32>,
        max_duration: Option<Duration>,
    },
}

This struct represents the policy to execute retries.

Variants

Infinite

Infinite

Infinite retry strategy.

None

None

No retry strategy, fail on first failure.

FixedDelay

Fixed delay

Retry with a fixed delay strategy.

Fields

interval: Duration

Interval

Interval between retries.

max_attempts: Option<u32>

Max attempts

Gives up retrying when either this number of attempts is reached, or max_duration (if set) is reached first. Infinite retries if this field and max_duration are unset.

max_duration: Option<Duration>

Max duration

Gives up retrying when either the retry loop lasted for this given max duration, or max_attempts (if set) is reached first. Infinite retries if this field and max_attempts are unset.

Exponential

Exponential

Retry with an exponential strategy. The next retry is computed as min(last_retry_interval * factor, max_interval).

Fields

initial_interval: Duration

Initial Interval

Initial interval for the first retry attempt.

factor: f32

Factor

The factor to use to compute the next retry attempt. This value should be higher than 1.0

max_interval: Option<Duration>

Max interval

Maximum interval between retries.

max_attempts: Option<u32>

Max attempts

Gives up retrying when either this number of attempts is reached, or max_duration (if set) is reached first. Infinite retries if this field and max_duration are unset.

max_duration: Option<Duration>

Max duration

Gives up retrying when either the retry loop lasted for this given max duration, or max_attempts (if set) is reached first. Infinite retries if this field and max_attempts are unset.

Implementations

impl RetryPolicy

pub fn fixed_delay( interval: Duration, max_attempts: Option<u32>, max_duration: Option<Duration>, ) -> Self

pub fn exponential( initial_interval: Duration, factor: f32, max_attempts: Option<u32>, max_interval: Option<Duration>, max_duration: Option<Duration>, ) -> Self

Trait Implementations

impl Clone for RetryPolicy

fn clone(&self) -> RetryPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryPolicy

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

Formats the value using the given formatter.

impl Default for RetryPolicy

fn default() -> RetryPolicy

Returns the “default value” for a type.