Struct LimitedElapsedTime 

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

A polling policy decorator that limits the total time in the polling loop.

This policy decorates an inner policy and limits the duration of polling loops. While the time spent in the polling loop (including time in backoff) is less than the prescribed duration the on_error() method returns the results of the inner policy. After that time it returns Exhausted if the inner policy returns Continue.

The remaining_time() function returns the remaining time. This is always Duration::ZERO once or after the policy’s deadline is reached.

Parameters

• P - the inner polling policy, defaults to Aip194Strict.

Implementations

impl LimitedElapsedTime

pub fn new(maximum_duration: Duration) -> Self

Creates a new instance, with the default inner policy.

Example

use std::time::{Duration, Instant};
let policy = LimitedElapsedTime::new(Duration::from_secs(10));
let state = PollingState::default().set_start(Instant::now() - Duration::from_secs(20));
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> LimitedElapsedTime<P>

where P: PollingErrorPolicy,

pub fn custom(inner: P, maximum_duration: Duration) -> Self

Creates a new instance with a custom inner policy.

Example

use std::time::{Duration, Instant};
let policy = LimitedElapsedTime::custom(AlwaysContinue, Duration::from_secs(10));
let state = PollingState::default().set_start(Instant::now() - Duration::from_secs(20));
assert!(policy.on_error(&state, 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 LimitedElapsedTime<P>

where P: PollingErrorPolicy + Debug,

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

Formats the value using the given formatter.

impl<P> PollingErrorPolicy for LimitedElapsedTime<P>

where P: PollingErrorPolicy + 'static,