pub struct ConnectorError { /* private fields */ }
Expand description
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§
Source§impl ConnectorError
impl ConnectorError
Sourcepub fn timeout(source: Box<dyn Error + Sync + Send>) -> ConnectorError
pub fn timeout(source: Box<dyn Error + Sync + Send>) -> ConnectorError
Construct a ConnectorError
from an error caused by a timeout
Timeout errors are typically retried on a new connection.
Sourcepub fn with_connection(self, info: ConnectionMetadata) -> ConnectorError
pub fn with_connection(self, info: ConnectionMetadata) -> ConnectorError
Include connection information along with this error
Sourcepub fn never_connected(self) -> ConnectorError
pub fn never_connected(self) -> ConnectorError
Set the connection status on this error to report that a connection was never established
Sourcepub fn user(source: Box<dyn Error + Sync + Send>) -> ConnectorError
pub fn user(source: Box<dyn Error + Sync + Send>) -> ConnectorError
Construct a ConnectorError
from an error caused by the user (e.g. invalid HTTP request)
Sourcepub fn io(source: Box<dyn Error + Sync + Send>) -> ConnectorError
pub fn io(source: Box<dyn Error + Sync + Send>) -> ConnectorError
Construct a ConnectorError
from an IO related error (e.g. socket hangup)
Sourcepub fn other(
source: Box<dyn Error + Sync + Send>,
kind: Option<ErrorKind>,
) -> ConnectorError
pub fn other( source: Box<dyn Error + Sync + Send>, kind: Option<ErrorKind>, ) -> ConnectorError
Construct a ConnectorError
from an different unclassified error.
Optionally, an explicit Kind
may be passed.
Sourcepub fn is_timeout(&self) -> bool
pub fn is_timeout(&self) -> bool
Returns true if the error is an timeout error
Sourcepub fn is_user(&self) -> bool
pub fn is_user(&self) -> bool
Returns true if the error is a user-caused error (e.g., invalid HTTP request)
Sourcepub fn as_other(&self) -> Option<ErrorKind>
pub fn as_other(&self) -> Option<ErrorKind>
Returns the optional error kind associated with an unclassified error
Sourcepub fn into_source(self) -> Box<dyn Error + Sync + Send>
pub fn into_source(self) -> Box<dyn Error + Sync + Send>
Grants ownership of this error’s source.
Sourcepub fn connection_metadata(&self) -> Option<&ConnectionMetadata>
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.