pub struct Config { /* private fields */ }
Expand description

Retry Policy Configuration

Without specific use cases, users should generally rely on the default values set by Config::default.

Currently these fields are private and no setters provided. As needed, this configuration will become user-modifiable in the future.

Implementations§

source§

impl Config

source

pub fn with_base(self, base: fn() -> f64) -> Self

Override b in the exponential backoff computation

By default, base is a randomly generated value between 0 and 1. In tests, it can be helpful to override this:

use aws_smithy_client::retry::Config;
let conf = Config::default().with_base(||1_f64);
source

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

Override the maximum number of attempts

max_attempts must be set to a value of at least 1 (indicating that retries are disabled).

source

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

Override the default backoff multiplier of 1 second.

Example

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

  • 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 has_retry(&self) -> bool

Returns true if retry is enabled with this config

Trait Implementations§

source§

impl Clone for Config

source§

fn clone(&self) -> Config

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 Config

source§

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

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

impl Default for Config

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl From<RetryConfig> for Config

source§

fn from(conf: RetryConfig) -> Self

Converts to this type from the input type.

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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more