Enum RetryError 

pub enum RetryError<E> {
    Aborted {
        attempts: u32,
        elapsed: Duration,
        failure: RetryAttemptFailure<E>,
    },
    AttemptsExceeded {
        attempts: u32,
        max_attempts: u32,
        elapsed: Duration,
        last_failure: RetryAttemptFailure<E>,
    },
    MaxElapsedExceeded {
        attempts: u32,
        elapsed: Duration,
        max_elapsed: Duration,
        last_failure: Option<RetryAttemptFailure<E>>,
    },
}

Error returned when a retry executor terminates without a successful result.

The generic parameter E is the caller’s application error type. It is preserved in the final RetryAttemptFailure whenever the terminal failure came from the user operation.

Variants

Aborted

The configured crate::RetryDecider returned crate::RetryDecision::Abort for the last application error.

Fields

attempts: u32

Number of attempts that were executed.

elapsed: Duration

Total elapsed time observed by the retry executor.

failure: RetryAttemptFailure<E>

Failure that caused the abort.

AttemptsExceeded

The maximum number of attempts has been exhausted.

Fields

attempts: u32

Number of attempts that were executed.

max_attempts: u32

Configured attempt limit.

elapsed: Duration

Total elapsed time observed by the retry executor.

last_failure: RetryAttemptFailure<E>

Last observed failure.

MaxElapsedExceeded

The total elapsed retry budget has been exhausted.

Fields

attempts: u32

Number of attempts that were executed.

elapsed: Duration

Total elapsed time observed by the retry executor.

max_elapsed: Duration

Configured elapsed budget.

last_failure: Option<RetryAttemptFailure<E>>

Last failure, if any attempt ran before the budget was exhausted.

Implementations

impl<E> RetryError<E>

pub fn attempts(&self) -> u32

Returns the number of attempts that were executed.

Parameters

This method has no parameters.

Returns

The number of operation attempts observed before termination.

Errors

This method does not return errors.

pub fn elapsed(&self) -> Duration

Returns the elapsed time recorded at termination.

Parameters

This method has no parameters.

Returns

The elapsed duration recorded by the retry executor when it stopped.

Errors

This method does not return errors.

pub fn last_failure(&self) -> Option<&RetryAttemptFailure<E>>

Returns the last failure, if one exists.

Parameters

This method has no parameters.

Returns

Some(&RetryAttemptFailure<E>) when at least one attempt failure was observed; None when the elapsed budget was exhausted before any attempt ran.

Errors

This method does not return errors.

pub fn last_error(&self) -> Option<&E>

Returns the last application error, if one exists.

Parameters

This method has no parameters.

Returns

Some(&E) when the terminal failure wraps an application error; None for timeout failures or elapsed-budget failures with no attempt.

Errors

This method does not return errors.

pub fn into_last_error(self) -> Option<E>

Consumes the retry error and returns the last application error when the final failure wraps one.

Parameters

This method has no parameters.

Returns

Some(E) when the terminal failure owns an application error; None when the terminal failure was a timeout or when no attempt ran.

Errors

This method does not return errors.

Trait Implementations

impl<E: Clone> Clone for RetryError<E>

fn clone(&self) -> RetryError<E>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug> Debug for RetryError<E>

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

Formats the value using the given formatter.

impl<E> Display for RetryError<E>

where E: Display,

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

Formats the retry error for diagnostics.

Parameters

• f: Formatter provided by the standard formatting machinery.

Returns

fmt::Result from the formatter.

Errors

Returns a formatting error if the underlying formatter fails.

impl<E> Error for RetryError<E>

where E: Error + 'static,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the source application error when one is available.

Parameters

This method has no parameters.

Returns

Some(&dyn Error) when the terminal failure wraps an application error that implements std::error::Error; otherwise None.

Errors

This method does not return errors.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<E: PartialEq> PartialEq for RetryError<E>

fn eq(&self, other: &RetryError<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E: Eq> Eq for RetryError<E>

impl<E> StructuralPartialEq for RetryError<E>