Enum RetryKind

#[non_exhaustive]
pub enum RetryKind {
    Error(ErrorKind),
    Explicit(Duration),
    UnretryableFailure,
    Unnecessary,
}

RetryKind describes how a request MAY be retried for a given response

A RetryKind describes how a response MAY be retried; it does not mandate retry behavior. The actual retry behavior is at the sole discretion of the RetryStrategy in place. A RetryStrategy may ignore the suggestion for a number of reasons including but not limited to:

• Number of retry attempts exceeded
• The required retry delay exceeds the maximum backoff configured by the client
• No retry tokens are available due to service health

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Error(ErrorKind)

Retry the associated request due to a known ErrorKind.

Explicit(Duration)

An Explicit retry (e.g. from x-amz-retry-after).

Note: The specified Duration is considered a suggestion and may be replaced or ignored.

UnretryableFailure

The response was a failure that should not be retried.

Unnecessary

The response was successful, so no retry is necessary.

Trait Implementations

impl Debug for RetryKind

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

Formats the value using the given formatter.

impl PartialEq for RetryKind

fn eq(&self, other: &RetryKind) -> 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 Eq for RetryKind

impl StructuralPartialEq for RetryKind