Struct WsError 

pub struct WsError { /* private fields */ }

Extended WebSocket error with classification.

Implementations

impl WsError

pub fn new(kind: WsErrorKind, message: impl Into<String>) -> Self

Creates a new WsError with the specified kind and message.

pub fn with_source<E>( kind: WsErrorKind, message: impl Into<String>, source: E, ) -> Self

where E: Error + Send + Sync + 'static,

Creates a new WsError with a source error.

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

Creates a transient error.

pub fn transient_with_source<E>(message: impl Into<String>, source: E) -> Self

where E: Error + Send + Sync + 'static,

Creates a transient error with a source.

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

Creates a permanent error.

pub fn permanent_with_source<E>(message: impl Into<String>, source: E) -> Self

where E: Error + Send + Sync + 'static,

Creates a permanent error with a source.

pub fn kind(&self) -> WsErrorKind

Returns the error kind.

pub fn message(&self) -> &str

Returns the error message.

pub fn is_transient(&self) -> bool

Returns true if this is a transient error.

pub fn is_permanent(&self) -> bool

Returns true if this is a permanent error.

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

Returns the source error, if any.

pub fn from_tungstenite(err: &Error) -> Self

Classifies a tungstenite WebSocket error.

pub fn from_error(err: &Error) -> Self

Classifies a generic error and wraps it in a WsError.

Trait Implementations

impl Debug for WsError

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

Formats the value using the given formatter.

impl Display for WsError

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

Formats the value using the given formatter.

impl Error for WsError

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.