Struct Error

pub struct Error(/* private fields */);

An error encountered while sending an HTTP request or receiving an HTTP response.

Note that errors are typically caused by failed I/O or protocol errors. 4xx or 5xx responses successfully received from the server are generally not considered an error case.

This type is intentionally opaque, as sending an HTTP request involves many different moving parts, some of which can be platform or device-dependent. It is recommended that you use the kind method to get a more generalized classification of error types that this error could be if you need to handle different sorts of errors in different ways.

If you need to get more specific details about the reason for the error, you can use the source method. We do not provide any stability guarantees about what error sources are returned.

Implementations

impl Error

pub fn kind(&self) -> &ErrorKind

Get the kind of error this represents.

The kind returned may not be matchable against any documented variants if the reason for the error is unknown. Unknown errors may be an indication of a bug, or an error condition that we do not recognize appropriately. Either way, please report such occurrences to us!

pub fn is_client(&self) -> bool

Returns true if this error was likely caused by the client.

Usually indicates that the client was misconfigured or used to send invalid data to the server. Requests that return these sorts of errors probably should not be retried without first fixing the request parameters.

pub fn is_network(&self) -> bool

Returns true if this is an error likely related to network failures.

Network operations are inherently unreliable. Sometimes retrying the request once or twice is enough to resolve the error.

pub fn is_server(&self) -> bool

Returns true if this error was likely the fault of the server.

pub fn is_timeout(&self) -> bool

Returns true if this error is caused from exceeding a configured timeout.

A request could time out for any number of reasons, for example:

• Slow or broken network preventing the server from receiving the request or replying in a timely manner.
• The server received the request but is taking a long time to fulfill the request.

Sometimes retrying the request once or twice is enough to resolve the error.

pub fn is_tls(&self) -> bool

Returns true if this error is related to SSL/TLS.

pub fn local_addr(&self) -> Option<SocketAddr>

Get the local socket address of the last-used connection involved in this error, if known.

If the request that caused this error failed to create a local socket for connecting then this will return None.

pub fn remote_addr(&self) -> Option<SocketAddr>

Get the remote socket address of the last-used connection involved in this error, if known.

If the request that caused this error failed to connect to any server, then this will return None.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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 StdError + '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<Error> for Error

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

fn from(error: Error) -> Error

Converts to this type from the input type.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.

impl PartialEq<ErrorKind> for Error

fn eq(&self, kind: &ErrorKind) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.