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)

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

Transient

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.

Fields

err: E

retry_after: Option<Duration>

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 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> 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>

Converts to this type from the input type.

impl<E> PartialEq 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.