Struct ConnectorError

pub struct ConnectorError { /* private fields */ }

Available on crate feature client only.

Error from the underlying Connector

Connector exists to attach a ConnectorErrorKind to what would otherwise be an opaque Box<dyn Error> that comes off a potentially generic or dynamic connector. The attached kind is used to determine what retry behavior should occur (if any) based on the connector error.

Implementations

impl ConnectorError

pub fn timeout(source: Box<dyn Error + Send + Sync>) -> Self

Construct a ConnectorError from an error caused by a timeout

Timeout errors are typically retried on a new connection.

pub fn with_connection(self, info: ConnectionMetadata) -> Self

Include connection information along with this error

pub fn never_connected(self) -> Self

Set the connection status on this error to report that a connection was never established

pub fn user(source: Box<dyn Error + Send + Sync>) -> Self

Construct a ConnectorError from an error caused by the user (e.g. invalid HTTP request)

pub fn io(source: Box<dyn Error + Send + Sync>) -> Self

Construct a ConnectorError from an IO related error (e.g. socket hangup)

pub fn other( source: Box<dyn Error + Send + Sync>, kind: Option<ErrorKind>, ) -> Self

Construct a ConnectorError from an different unclassified error.

Optionally, an explicit Kind may be passed.

pub fn is_io(&self) -> bool

Returns true if the error is an IO error

pub fn is_timeout(&self) -> bool

Returns true if the error is an timeout error

pub fn is_user(&self) -> bool

Returns true if the error is a user-caused error (e.g., invalid HTTP request)

pub fn is_other(&self) -> bool

Returns true if the error is an unclassified error.

pub fn as_other(&self) -> Option<ErrorKind>

Returns the optional error kind associated with an unclassified error

pub fn into_source(self) -> Box<dyn Error + Send + Sync>

Grants ownership of this error’s source.

pub fn connection_metadata(&self) -> Option<&ConnectionMetadata>

Returns metadata about the connection

If a connection was established and provided by the internal connector, a connection will be returned.

Trait Implementations

impl Debug for ConnectorError

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

Formats the value using the given formatter.

impl Display for ConnectorError

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

Formats the value using the given formatter.

impl Error for ConnectorError

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.