#[non_exhaustive]
pub struct RetryConfig { /* private fields */ }
Expand description

Retry configuration for requests.

Implementations§

source§

impl RetryConfig

source

pub fn standard() -> Self

Creates a default RetryConfig with RetryMode::Standard and max attempts of three.

source

pub fn disabled() -> Self

Creates a RetryConfig that has retries disabled.

source

pub fn with_retry_mode(self, retry_mode: RetryMode) -> Self

Set this config’s retry mode.

source

pub fn with_max_attempts(self, max_attempts: u32) -> Self

Set the maximum number of times a request should be tried, including the initial attempt. This value must be greater than zero.

source

pub fn with_initial_backoff(self, initial_backoff: Duration) -> Self

Set the multiplier used when calculating backoff times as part of an exponential backoff with jitter strategy. Most services should work fine with the default duration of 1 second, but if you find that your requests are taking too long due to excessive retry backoff, try lowering this value.

Example

For a request that gets retried 3 times, when initial_backoff is 1 seconds:

  • the first retry will occur after 0 to 1 seconds
  • the second retry will occur after 0 to 2 seconds
  • the third retry will occur after 0 to 4 seconds

For a request that gets retried 3 times, when initial_backoff is 30 milliseconds:

  • the first retry will occur after 0 to 30 milliseconds
  • the second retry will occur after 0 to 60 milliseconds
  • the third retry will occur after 0 to 120 milliseconds
source

pub fn mode(&self) -> RetryMode

Returns the retry mode.

source

pub fn max_attempts(&self) -> u32

Returns the max attempts.

source

pub fn initial_backoff(&self) -> Duration

Returns the backoff multiplier duration.

source

pub fn has_retry(&self) -> bool

Returns true if retry is enabled with this config

Trait Implementations§

source§

impl Clone for RetryConfig

source§

fn clone(&self) -> RetryConfig

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RetryConfig

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq<RetryConfig> for RetryConfig

source§

fn eq(&self, other: &RetryConfig) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for RetryConfig

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.