Struct RetryState 

#[non_exhaustive]
pub struct RetryState {
    pub idempotent: bool,
    pub start: Instant,
    pub attempt_count: u32,
}

The input into a retry policy query.

On an error, the client library queries the retry policy as to whether it should make a new attempt. The client library provides an instance of this type to the retry policy.

This struct may gain new fields in future versions of the client libraries.

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.

idempotent: bool

If true, the request is idempotent and it is safe to retry.

Some policies retry non-idempotent operations because they are safe for a given configuration of the service or client.

start: Instant

The start time for this retry loop.

attempt_count: u32

The number of times the request has been attempted.

Implementations

impl RetryState

pub fn new(idempotent: bool) -> Self

Create a new instance.

pub fn set_idempotent(self, v: bool) -> Self

Update the idempotency.

pub fn set_start<T: Into<Instant>>(self, v: T) -> Self

Update the start time, useful in mocks.

pub fn set_attempt_count<T: Into<u32>>(self, v: T) -> Self

Update the attempt count, useful in mocks.

Trait Implementations

impl Clone for RetryState

fn clone(&self) -> RetryState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetryState

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

Formats the value using the given formatter.

impl Default for RetryState

fn default() -> Self

Returns the “default value” for a type.