Struct Error 

pub struct Error { /* private fields */ }

An error carrying a classified ErrorKind, a message, and an optional source.

Implementations

impl Error

pub fn new(kind: ErrorKind) -> Self

Creates an error of the given ErrorKind with an empty message.

pub fn from_boxed(kind: ErrorKind, error: impl Into<BoxError>) -> Self

Wraps an arbitrary error under the given ErrorKind.

If the error already is an Error, it is returned unchanged and keeps its own kind.

pub fn invalid(message: impl Into<String>) -> Self

Creates an Invalid error with a message.

pub fn backend(message: impl Into<String>) -> Self

Creates a Backend error with a message.

pub fn worker(message: impl Into<String>) -> Self

Creates a Worker error with a message.

pub fn with_message(self, message: impl Into<String>) -> Self

Replaces the message.

pub fn with_source(self, source: impl Into<BoxError>) -> Self

Attaches a source error.

pub const fn with_status(self, status: StatusCode) -> Self

Attaches the response status that caused the error.

pub fn with_uri(self, uri: Uri) -> Self

Attaches the URI of the request that failed.

pub const fn with_retry_after(self, delay: Duration) -> Self

Asks for the failed request’s tag to be paused for delay before it is retried, e.g. from a Retry-After header.

pub const fn kind(&self) -> ErrorKind

Returns the ErrorKind.

pub fn message(&self) -> &str

Returns the message, which may be empty.

pub const fn status(&self) -> Option<StatusCode>

Returns the response status that caused the error, if any.

pub fn uri(&self) -> Option<&Uri>

Returns the URI of the request that failed, if known.

pub const fn retry_after(&self) -> Option<Duration>

Returns how long to wait before retrying, if the remote said so.

pub const fn is_retryable(&self) -> bool

Whether the failed operation is worth retrying.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Returns the lower-level source of this error, if any.

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 From<!> for Error

fn from(never: Infallible) -> Self

Converts to this type from the input type.

impl From<&Error> for Failure

fn from(error: &Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<InvalidUri> for Error

fn from(error: InvalidUri) -> Self

Converts to this type from the input type.

impl IntoOutcome for Error

fn into_outcome(self) -> Outcome

Converts self into an Outcome.