Struct ConnectionError 

pub struct ConnectionError { /* private fields */ }

Available on crate feature net only.

A classified error produced while establishing or using a client connection.

Classification can inform endpoint availability; it does not grant permission to replay an application operation that might already have been processed.

The original error remains available as the source. Adding context only wraps that source and therefore preserves the classification.

Implementations

impl ConnectionError

pub fn new( source: impl Into<Box<dyn Error + Sync + Send>>, domain: ConnectionErrorDomain, kind: ConnectionErrorKind, ) -> ConnectionError

Create a classified connection error.

pub fn transport( source: impl Into<Box<dyn Error + Sync + Send>>, kind: ConnectionErrorKind, ) -> ConnectionError

Create an error which occurred while establishing the transport path.

pub fn application( source: impl Into<Box<dyn Error + Sync + Send>>, kind: ConnectionErrorKind, ) -> ConnectionError

Create an error which occurred while establishing the end-to-end connection.

This includes intermediate end-to-end protocols such as TLS to the origin, not only the final application protocol.

pub fn local( source: impl Into<Box<dyn Error + Sync + Send>>, kind: ConnectionErrorKind, ) -> ConnectionError

Create an error produced by client-local acquisition or orchestration machinery.

pub fn unknown( source: impl Into<Box<dyn Error + Sync + Send>>, ) -> ConnectionError

Create an unclassified connection error.

pub fn domain(&self) -> ConnectionErrorDomain

Return the architectural domain in which the failure occurred.

pub fn kind(&self) -> ConnectionErrorKind

Return the protocol-independent kind of failure.

pub fn policy_scope(&self) -> ConnectionPolicyScope

Policy under which this failure was observed. Negative caches must not apply request-specific failures to other requests.

pub fn with_policy_scope(self, scope: ConnectionPolicyScope) -> ConnectionError

Identify the policy that produced this failure without changing its domain or kind. Request-specific failures are neutral for shared endpoint availability and must not clear or increase shared backoff.

pub fn set_policy_scope( &mut self, scope: ConnectionPolicyScope, ) -> &mut ConnectionError

Identify the policy that produced this failure without changing its domain or kind. Request-specific failures are neutral for shared endpoint availability and must not clear or increase shared backoff.

pub fn get_ref(&self) -> &(dyn Error + Sync + Send + 'static)

Return the original error, including any attached context.

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

Consume this error and return its boxed source.

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

Convert this error into a BoxError without losing its classification.

pub fn into_opaque_error(self) -> OpaqueError

Convert this error into an OpaqueError without losing its classification.

pub fn context<M>(self, value: M) -> ConnectionError

where M: Debug + Display + Send + Sync + 'static,

Add context to the source error.

pub fn context_hex<M>(self, value: M) -> ConnectionError

where M: Debug + Send + Sync + 'static,

Add context using fmt::LowerHex for its formatting.

pub fn context_debug<M>(self, value: M) -> ConnectionError

where M: Debug + Send + Sync + 'static,

Add context using fmt::Debug for its display formatting.

pub fn context_field<M>(self, key: &'static str, value: M) -> ConnectionError

where M: Debug + Display + Send + Sync + 'static,

Add keyed context to the source error.

pub fn context_str_field<M>( self, key: &'static str, value: M, ) -> ConnectionError

where M: Into<String>,

Add a keyed string-like context value to the source error.

pub fn context_hex_field<M>( self, key: &'static str, value: M, ) -> ConnectionError

where M: Debug + Send + Sync + 'static,

Add keyed context using fmt::LowerHex for its formatting.

pub fn context_debug_field<M>( self, key: &'static str, value: M, ) -> ConnectionError

where M: Debug + Send + Sync + 'static,

Add keyed context using fmt::Debug for its display formatting.

pub fn with_context<C, F>(self, create: F) -> ConnectionError

where C: Debug + Display + Send + Sync + 'static, F: FnOnce() -> C,

Lazily add context to the source error.

pub fn with_context_hex<C, F>(self, create: F) -> ConnectionError

where C: Debug + Send + Sync + 'static, F: FnOnce() -> C,

Lazily add context using fmt::LowerHex for its formatting.

pub fn with_context_debug<C, F>(self, create: F) -> ConnectionError

where C: Debug + Send + Sync + 'static, F: FnOnce() -> C,

Lazily add context using fmt::Debug for its display formatting.

pub fn with_context_field<C, F>( self, key: &'static str, create: F, ) -> ConnectionError

where C: Debug + Display + Send + Sync + 'static, F: FnOnce() -> C,

Lazily add keyed context to the source error.

pub fn with_context_str_field<C, F>( self, key: &'static str, create: F, ) -> ConnectionError

where C: Into<String>, F: FnOnce() -> C,

Lazily add a keyed string-like context value to the source error.

pub fn with_context_hex_field<C, F>( self, key: &'static str, create: F, ) -> ConnectionError

where C: Debug + Send + Sync + 'static, F: FnOnce() -> C,

Lazily add keyed context using fmt::LowerHex for its formatting.

pub fn with_context_debug_field<C, F>( self, key: &'static str, create: F, ) -> ConnectionError

where C: Debug + Send + Sync + 'static, F: FnOnce() -> C,

Lazily add keyed context using fmt::Debug for its display formatting.

pub fn backtrace(self) -> ConnectionError

Capture a backtrace and attach it to the source error.

Trait Implementations

impl Debug for ConnectionError

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

Formats the value using the given formatter.

impl Display for ConnectionError

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

Formats the value using the given formatter.

impl Error for ConnectionError

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 ConnectionError

fn from(error: !) -> ConnectionError

Converts to this type from the input type.

impl From<Box<dyn Error + Sync + Send>> for ConnectionError

fn from(source: Box<dyn Error + Sync + Send>) -> ConnectionError

Converts to this type from the input type.

impl From<HttpProxyError> for ConnectionError

fn from(error: HttpProxyError) -> ConnectionError

Converts to this type from the input type.

impl From<Socks5ProxyError> for ConnectionError

fn from(error: Socks5ProxyError) -> ConnectionError

Converts to this type from the input type.