Struct LimitedElapsedTime

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

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

This policy decorates an inner policy and limits the duration of retry loops. While the time spent in the retry 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 retry policy, defaults to Aip194Strict.

Implementations

impl LimitedElapsedTime

pub fn new(maximum_duration: Duration) -> Self

Creates a new instance, with the default inner policy.

Example

fn customize_retry_policy(builder: impl RequestOptionsBuilder) -> impl RequestOptionsBuilder {
    builder.with_retry_policy(LimitedElapsedTime::new(std::time::Duration::from_secs(10)))
}

Example

let d = std::time::Duration::from_secs(10);
let policy = LimitedElapsedTime::new(d);
assert!(policy.remaining_time(std::time::Instant::now(), 0) <= Some(d));

impl<P> LimitedElapsedTime<P>

where P: RetryPolicy,

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

Creates a new instance with a custom inner policy.

Example

fn customize_retry_policy(builder: impl RequestOptionsBuilder) -> impl RequestOptionsBuilder {
    builder.with_retry_policy(LimitedElapsedTime::custom(AlwaysRetry, std::time::Duration::from_secs(10)))
}

Example

let d = std::time::Duration::from_secs(10);
let policy = AlwaysRetry.with_time_limit(d);
assert!(policy.remaining_time(std::time::Instant::now(), 0) <= Some(d));
assert!(policy.on_error(std::time::Instant::now(), 1, false, error::Error::other(format!("test"))).is_continue());

Trait Implementations

impl<P> Debug for LimitedElapsedTime<P>

where P: RetryPolicy + Debug,

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

Formats the value using the given formatter.

impl<P> RetryPolicy for LimitedElapsedTime<P>

where P: RetryPolicy + 'static,

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.