Enum ClassifiedError 

pub enum ClassifiedError<'a, E> {
    None(&'a E),
    Transient(&'a E),
    Permanent(&'a E),
}

Used to classify errors and API response statuses as None, Transient or Permanent.

This classification will, in turn, be used to decide whether the request should be re-tried using the backon crate or not.

Variants

None(&'a E)

The passed type did not represent an error of any kind. Success responses should not be retried.

Transient(&'a E)

A potentially temporary error, such as a network glitch causing a connection issue. These errors are often suitable for retrying the request.

Permanent(&'a E)

A likely permanent error, such as a request with invalid data. Retrying these errors are ineffective since the outcome shouldn’t change.

Implementations

impl<E> ClassifiedError<'_, E>

pub const fn is_none(&self) -> bool

Returns whether the error has been classified as None.

This is used for types that may, or may not, represent an error condition. In the event that the type represents a success or Ok state, ClassifiedError::None can be used.

Notes

• ClassifiedError is used to determine whether an API request should be retried or not. If is_none is true, everything is good and the API call should not be retried.

pub const fn is_transient(&self) -> bool

Returns whether the error has been classified as Transient.

A transient error is a potentially temporary error, such as a network glitch causing a connection issue. These errors are often suitable for retrying the request.

Notes

• ClassifiedError is used to determine whether an API request should be retried or not. If is_transient is true, the error result might change on subsequent API calls. A retry is worth a shot.

pub const fn is_permanent(&self) -> bool

Returns whether the error has been classified as Permanent.

A likely permanent error, such as a request with invalid data. Retrying these errors are ineffective since the outcome shouldn’t change.

Notes

• ClassifiedError is used to determine whether an API request should be retried or not. If is_permanent is true, the error result is not expected to change on subsequent API calls. The API call should not be retried.

impl<'a, E: ClassifiableError<'a, E>> ClassifiedError<'a, E>

pub fn new(error: &'a E) -> Self

Wraps an error, or a status, in a ClassifiedError enum. This wrapper indicates the type of failure.

This classification will, in turn, be used to decide whether the request should be retried or not.

Trait Implementations

impl<'a, E: Debug> Debug for ClassifiedError<'a, E>

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

Formats the value using the given formatter.

impl<E: Display> Display for ClassifiedError<'_, E>

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

Formats the value using the given formatter.

impl<'a, E: ClassifiableError<'a, E>> From<&'a E> for ClassifiedError<'a, E>

fn from(error: &'a E) -> Self

Wraps an error, or a status, in a ClassifiedError enum. This wrapper indicates the type of failure.

This classification will, in turn, be used to decide whether the request should be retried or not.