Enum WsError 

#[non_exhaustive]
pub enum WsError {
    Transport {
        source: TransportError,
    },
    Decode {
        context: String,
        source: Error,
    },
    MissingArg {
        raw: String,
    },
    Encode {
        source: Error,
    },
    Configuration(String),
}

Errors from the WebSocket layer.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Transport

A WebSocket transport error (connection, TLS, I/O, …).

Fields

source: TransportError

Finding the position of the error

Decode

A WebSocket event or push payload could not be decoded.

Fields

context: String

Human-readable context: channel name, event type, or a snippet of the raw payload.

source: Error

The underlying deserialization error.

MissingArg

A push event was missing the required arg field.

Fields

raw: String

The raw JSON text of the offending event (truncated if large).

Encode

An outgoing WebSocket request could not be serialized.

Fields

source: Error

The underlying serialization error.

Configuration(String)

The WebSocket client was used in an invalid way (wrong channel group, missing credentials, …).

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, __formatter: &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.

impl From<TransportError> for WsError

fn from(source: TransportError) -> Self

Converts to this type from the input type.

impl From<WsError> for Error

fn from(source: WsError) -> Self

Converts to this type from the input type.