Struct tryhard::RetryFutureConfig

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

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<F, R, E>(
    self,
    f: F
) -> RetryFutureConfig<CustomBackoffStrategy<F>, OnRetryT> where
    F: FnMut(u32, &E) -> R,
    R: Into<RetryPolicy>, 

Use a custom backoff specified by some function.

See RetryFuture::custom_backoff for more details.

pub fn on_retry<F, OnRetryFuture, E>(
    self,
    f: F
) -> RetryFutureConfig<BackoffT, F> where
    F: FnMut(u32, Option<Duration>, &E) -> OnRetryFuture,
    OnRetryFuture: Future + Send + 'static,
    OnRetryFuture::Output: Send + 'static, 

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>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

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

pub fn eq(&self, other: &RetryFutureConfig<BackoffT, OnRetryT>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &RetryFutureConfig<BackoffT, OnRetryT>) -> bool

This method tests for !=.

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

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