Struct Retry

pub struct Retry {
    pub name: &'static str,
    pub attempts: u32,
    pub base_delay: Duration,
    pub delay_factor: f64,
    pub enable_jitter: bool,
}

Calls a fallible async function multiple times, with a given timeout.

If a base_delay is provided, the function is given an exponentially increasing delay on each run, up until the maximum number of attempts.

Returns the first successful result if any, or the last error.

Fields

name: &'static str

Name of the operation being retried.

attempts: u32

The number of attempts to make.

base_delay: Duration

The base delay after the first attempt, if provided.

delay_factor: f64

Exponential factor to increase the delay by on each attempt.

enable_jitter: bool

If true, the delay will be selected randomly from the range [delay/2, delay).

Implementations

impl Retry

pub const fn new(name: &'static str) -> Self

Construct a new Retry object with default parameters.

pub const fn attempts(self, attempts: u32) -> Self

Set the number of attempts to make.

pub const fn base_delay(self, base_delay: Duration) -> Self

Set the base delay.

pub const fn delay_factor(self, delay_factor: f64) -> Self

Set the exponential factor increasing delay.

pub const fn jitter(self, enabled: bool) -> Self

Enable jitter.

pub async fn run<T, E: Debug, Fut>( self, func: impl FnMut() -> Fut, ) -> Result<T, E>

where Fut: Future<Output = Result<T, E>>,

Run a falliable asynchronous function using this retry configuration.

Panics if the number of attempts is set to 0, or the base delay is incorrectly set to a negative duration.

Trait Implementations

impl Clone for Retry

fn clone(&self) -> Retry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Retry

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

Formats the value using the given formatter.

impl Copy for Retry