Enum backoff::Error

pub enum Error<E> {
    Permanent(E),
    Transient {
        err: E,
        retry_after: Option<Duration>,
    },
}

Error is the error value in an operation’s result.

Based on the two possible values, the operation may be retried.

Variants

Permanent(E)

Tuple Fields

0: E

Permanent means that it’s impossible to execute the operation successfully. This error is immediately returned from retry().

Transient

Fields

err: E

retry_after: Option<Duration>

Transient means that the error is temporary. If the retry_after is None the operation should be retried according to the backoff policy, else after the specified duration. Useful for handling ratelimits like a HTTP 429 response.

Implementations

impl<E> Error<E>

pub fn permanent(err: E) -> Self

pub fn transient(err: E) -> Self

pub fn retry_after(err: E, duration: Duration) -> Self

Creates a transient error which is retried after the specified duration. Useful for handling ratelimits like a HTTP 429 response.

Trait Implementations

impl<E> Debug for Error<E> where
    E: Debug, 

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

Formats the value using the given formatter.

impl<E> Display for Error<E> where
    E: Display, 

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

Formats the value using the given formatter.

impl<E> Error for Error<E> where
    E: Error, 

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

The lower-level source of this error, if any.

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

impl<E> From<E> for Error<E>

By default all errors are transient. Permanent errors can be constructed explicitly. This implementation is for making the question mark operator (?) and the try! macro to work.

fn from(err: E) -> Error<E>

Performs the conversion.

impl<E> PartialEq<Error<E>> for Error<E> where
    E: PartialEq, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.