Struct RetryPolicy 

#[non_exhaustive]
pub struct RetryPolicy {
    pub max_retries: u32,
    pub backoff_initial: Duration,
    pub backoff_max: Duration,
    pub backoff_jitter: f64,
    pub http_statuses: BTreeSet<u16>,
    pub respect_retry_after: bool,
    pub retry_connection_errors: bool,
    pub retry_timeouts: bool,
    pub predicate: Option<RetryPredicate>,
    pub budget: Option<Duration>,
}

How failed requests are retried.

Start from RetryPolicy::default or RetryPolicy::none and adjust with the builder methods (or set the public fields directly).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_retries: u32

Retries after the first attempt; 0 disables retries. Default 2.

backoff_initial: Duration

First backoff delay, doubled per attempt up to backoff_max; zero disables backoff. Default 0.5s.

backoff_max: Duration

Maximum backoff delay; zero disables backoff. Default 5s.

backoff_jitter: f64

Fraction of each delay randomly subtracted, in [0, 1]. Default 0.25.

http_statuses: BTreeSet<u16>

Statuses that are retried. Default 408, 429 and 500–599 (which includes TypeSafe’s 529).

respect_retry_after: bool

Honor retry-after-ms / Retry-After. Default true.

retry_connection_errors: bool

Retry Error::Connection. Default true.

retry_timeouts: bool

Retry Error::Timeout. Default true.

predicate: Option<RetryPredicate>

Extra predicate; returning true also triggers a retry.

budget: Option<Duration>

Total budget per SDK call including attempts and delays; None = unlimited. Default 30s.

Implementations

impl RetryPolicy

pub fn none() -> Self

A policy that never retries.

pub fn max_retries(self, n: u32) -> Self

Set max_retries.

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

Set the backoff bounds.

pub fn jitter(self, fraction: f64) -> Self

Set the jitter fraction.

pub fn statuses(self, statuses: impl IntoIterator<Item = u16>) -> Self

Replace the retryable status set.

pub fn budget(self, budget: Option<Duration>) -> Self

Set the total time budget.

pub fn respect_retry_after(self, yes: bool) -> Self

Whether to honor retry-after-ms / Retry-After.

pub fn retry_connection_errors(self, yes: bool) -> Self

Whether to retry Error::Connection.

pub fn retry_timeouts(self, yes: bool) -> Self

Whether to retry Error::Timeout.

pub fn retry_if( self, f: impl Fn(&Error) -> bool + Send + Sync + 'static, ) -> Self

Add a custom predicate.

Trait Implementations

impl Clone for RetryPolicy

fn clone(&self) -> RetryPolicy

Returns a duplicate of the value.

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() -> Self

Returns the “default value” for a type.