Struct WsError 

pub struct WsError(/* private fields */);

A WebSocket failure: a transport error, a refused upgrade, a server close, or one of the kit’s own timeouts.

Opaque on purpose: read it through kind, which no later tungstenite release can break, and classify it through polyoxide_venue::impl_ws_classification! in the venue crate that wraps it. Its source is the transport error it came from, when there is one.

Built from a tungstenite::Error by From, and by connect_timeout, closed, from_close_frame and no_answer for the failures the kit detects itself.

The basis is the boxed tungstenite::Error each socket crate wrapped: the errors of all five socket crates wrap this type instead since Stories 4.6 to 4.10. One divergence row stays with each venue: D19, what to do after Kind::AlreadyClosed (some venues stop, others reconnect).

Implementations

impl WsError

pub fn connect_timeout(after: Duration) -> Self

The connection did not open within after.

pub fn closed(code: Option<u16>, reason: impl Into<String>) -> Self

The server closed the connection with this code and reason; None and an empty reason for a close frame without a code, or an end of the stream with no close frame.

pub fn from_close_frame(frame: Option<&CloseFrame>) -> Self

The server closed the connection with this close frame, or with none.

pub fn no_answer(after: Duration) -> Self

No answer arrived within after.

pub fn kind(&self) -> Kind<'_>

What kind of failure this is.

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.

impl From<Error> for WsError

fn from(err: Error) -> Self

Converts to this type from the input type.