Struct RetryFutureConfig

pub struct RetryFutureConfig<BackoffT, OnRetryT> { /* private fields */ }

Configuration describing how to retry a future.

This is useful if you have many futures you want to retry in the same way.

Implementations

impl RetryFutureConfig<NoBackoff, NoOnRetry>

pub fn new(max_retries: u32) -> Self

Create a new configuration with a max number of retries and no backoff strategy.

impl<BackoffT, OnRetryT> RetryFutureConfig<BackoffT, OnRetryT>

pub fn max_delay(self, delay: Duration) -> Self

Set the max duration to sleep between each attempt.

pub fn no_backoff(self) -> RetryFutureConfig<NoBackoff, OnRetryT>

Remove the backoff strategy.

This will make the future be retried immediately without any delay in between attempts.

pub fn exponential_backoff( self, initial_delay: Duration, ) -> RetryFutureConfig<ExponentialBackoff, OnRetryT>

Use exponential backoff for retrying the future.

The first delay will be initial_delay and afterwards the delay will double every time.

pub fn fixed_backoff( self, delay: Duration, ) -> RetryFutureConfig<FixedBackoff, OnRetryT>

Use a fixed backoff for retrying the future.

The delay between attempts will always be delay.

pub fn linear_backoff( self, delay: Duration, ) -> RetryFutureConfig<LinearBackoff, OnRetryT>

Use a linear backoff for retrying the future.

The delay will be delay * attempt so it’ll scale linear with the attempt.

pub fn custom_backoff<B>( self, backoff_strategy: B, ) -> RetryFutureConfig<B, OnRetryT>

Use a custom backoff specified by some function.

See RetryFuture::custom_backoff for more details.

pub fn on_retry<F>(self, f: F) -> RetryFutureConfig<BackoffT, F>

Some async computation that will be spawned before each retry.

See RetryFuture::on_retry for more details.

Trait Implementations

impl<BackoffT: Clone, OnRetryT: Clone> Clone for RetryFutureConfig<BackoffT, OnRetryT>

fn clone(&self) -> RetryFutureConfig<BackoffT, OnRetryT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<BackoffT, OnRetryT> Debug for RetryFutureConfig<BackoffT, OnRetryT>

where BackoffT: Debug,

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

Formats the value using the given formatter.

impl<BackoffT: PartialEq, OnRetryT: PartialEq> PartialEq for RetryFutureConfig<BackoffT, OnRetryT>

fn eq(&self, other: &RetryFutureConfig<BackoffT, OnRetryT>) -> 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<BackoffT: Copy, OnRetryT: Copy> Copy for RetryFutureConfig<BackoffT, OnRetryT>

impl<BackoffT: Eq, OnRetryT: Eq> Eq for RetryFutureConfig<BackoffT, OnRetryT>

impl<BackoffT, OnRetryT> StructuralPartialEq for RetryFutureConfig<BackoffT, OnRetryT>