Struct LimitedAttemptCount

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

A polling policy decorator that limits the number of attempts.

This policy decorates an inner policy and limits polling total number of attempts. Setting the maximum number of attempts to 0 results in no polling attempts before the initial one.

The policy passes through the results from the inner policy as long as attempt_count < maximum_attempts. However, once the maximum number of attempts is reached, the policy replaces any Continue result with Exhausted.

Parameters

• P - the inner polling policy.

Implementations

impl LimitedAttemptCount

pub fn new(maximum_attempts: u32) -> Self

Creates a new instance, with the default inner policy.

Example

use std::time::Instant;
let policy = LimitedAttemptCount::new(5);
let attempt_count = 10;
assert!(policy.on_error(Instant::now(), attempt_count, error::Error::authentication("transient")).is_exhausted());

impl<P> LimitedAttemptCount<P>

where P: PollingPolicy,

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

Creates a new instance with a custom inner policy.

Example

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

Trait Implementations

impl<P> Debug for LimitedAttemptCount<P>

where P: PollingPolicy + Debug,

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

Formats the value using the given formatter.

impl<P> PollingPolicy for LimitedAttemptCount<P>

where P: PollingPolicy,

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

Query the polling policy after an error.

fn on_in_progress( &self, start: Instant, count: u32, operation_name: &str, ) -> Option<Error>

Called when the LRO is successfully polled, but the LRO is still in progress.