Struct RetryPolicy

pub struct RetryPolicy { /* private fields */ }

A template for configuring retry behavior

A default is provided, configured to retry a task 5 times with exponential backoff starting with a 1 second delay

Implementations

impl RetryPolicy

pub fn exponential(delay: Duration) -> Self

Configures policy with an exponential backoff delay.

By default, Futures will be retried 5 times.

These delays will increase in length over time. You may wish to cap just how long using the with_max_delay fn

pub fn fixed(delay: Duration) -> Self

Configures policy with a fixed backoff delay.

By default, Futures will be retried 5 times.

These delays will increase in length over time. You may wish to configure how many times a Future will be retried using the with_max_retries fn

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

Configures randomness to the delay between retries.

This is useful for services that have many clients which might all retry at the same time to avoid the “thundering herd” problem

pub fn with_max_delay(self, max: Duration) -> Self

Limits the maximum length of delay between retries

pub fn with_max_retries(self, max: usize) -> Self

Limits the maximum number of attempts a Future will be tried

pub async fn retry<T>(&self, task: T) -> Result<T::Item, T::Error>

where T: Task,

Retries a fallible Future with this policy’s configuration

pub async fn retry_if<T, C>( &self, task: T, condition: C, ) -> Result<T::Item, T::Error>

where T: Task, C: Condition<T::Error>,

Retries a fallible Future with this policy’s configuration under certain provided conditions

Trait Implementations

impl Clone for RetryPolicy

fn clone(&self) -> RetryPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RetryPolicy

fn default() -> Self

Returns the “default value” for a type.