Struct LimitedAttemptCount

pub struct LimitedAttemptCount<P = Aip194Strict>
where
    P: RetryPolicy,
{ /* private fields */ }

A retry policy decorator that limits the number of attempts.

This policy decorates an inner policy and limits the total number of attempts. Note that on_error() is not called before the initial (non-retry) attempt. Therefore, setting the maximum number of attempts to 0 or 1 results in no retry attempts.

The policy passes through the results from the inner policy as long as attempt_count < maximum_attempts. Once the maximum number of attempts is reached, the policy returns Exhausted if the inner policy returns Continue, and

Parameters

• P - the inner retry policy.

Implementations

impl LimitedAttemptCount

pub fn new(maximum_attempts: u32) -> Self

Creates a new instance, with the default inner policy.

Example

fn customize_retry_policy() -> options::ClientConfig {
    options::ClientConfig::new()
        .set_retry_policy(LimitedAttemptCount::new(5))
}

impl<P> LimitedAttemptCount<P>

where P: RetryPolicy,

pub fn custom(inner: P, maximum_attempts: u32) -> Self

Creates a new instance with a custom inner policy.

Example

fn customize_retry_policy(builder: impl RequestOptionsBuilder) -> impl RequestOptionsBuilder {
    builder.with_retry_policy(LimitedAttemptCount::custom(AlwaysRetry, 10))
}

Example

use std::time::Instant;
let policy = LimitedAttemptCount::custom(AlwaysRetry, 2);
assert!(policy.on_error(Instant::now(), 1, false, error::Error::other(format!("test"))).is_continue());
assert!(policy.on_error(Instant::now(), 2, false, error::Error::other(format!("test"))).is_exhausted());

Trait Implementations

impl<P> Debug for LimitedAttemptCount<P>

where P: RetryPolicy + Debug,

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

Formats the value using the given formatter.

impl<P> RetryPolicy for LimitedAttemptCount<P>

where P: RetryPolicy,

fn on_error( &self, start: Instant, count: u32, idempotent: bool, error: Error, ) -> RetryFlow

Query the retry policy after an error.

fn remaining_time( &self, loop_start: Instant, attempt_count: u32, ) -> Option<Duration>

The remaining time in the retry policy.