Struct LimitedAttemptCount 

pub struct LimitedAttemptCount<P = Aip194Strict>
where
    P: PollingErrorPolicy,
{ /* 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 state = PollingState::default().set_attempt_count(10_u32);
assert!(policy.on_error(&state, transient_error()).is_exhausted());

use google_cloud_gax::error::{Error, rpc::Code, rpc::Status};
fn transient_error() -> Error { Error::service(Status::default().set_code(Code::Unavailable)) }

impl<P> LimitedAttemptCount<P>

where P: PollingErrorPolicy,

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

Creates a new instance with a custom inner policy.

Example

let policy = LimitedAttemptCount::custom(AlwaysContinue, 2);
assert!(policy.on_error(&PollingState::default().set_attempt_count(1_u32), permanent_error()).is_continue());
assert!(policy.on_error(&PollingState::default().set_attempt_count(2_u32), permanent_error()).is_exhausted());

use google_cloud_gax::error::{Error, rpc::Code, rpc::Status};
fn permanent_error() -> Error { Error::service(Status::default().set_code(Code::Aborted)) }

Trait Implementations

impl<P> Debug for LimitedAttemptCount<P>

where P: PollingErrorPolicy + Debug,

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

Formats the value using the given formatter.

impl<P> PollingErrorPolicy for LimitedAttemptCount<P>

where P: PollingErrorPolicy,