Enum backoff::Error

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

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§

source§

impl<E> Error<E>

source

pub fn permanent(err: E) -> Self

source

pub fn transient(err: E) -> Self

source

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§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

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

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

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

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. Read more
source§

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.

source§

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

Converts to this type from the input type.
source§

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

source§

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

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

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.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V