Enum WsErr

#[non_exhaustive]
pub enum WsErr {
    Utf8(Utf8Error),
    InvalidWsState {
        supplied: u16,
    },
    ConnectionNotOpen,
    InvalidUrl {
        supplied: String,
    },
    InvalidCloseCode {
        supplied: u16,
    },
    ReasonStringToLong,
    ConnectionFailed {
        event: CloseEvent,
    },
    InvalidEncoding,
    CantDecodeBlob,
    UnknownDataType,
    Dom(u16),
    Other(String),
}

The error type for errors happening in ws_stream_wasm.

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.

Utf8(Utf8Error)

UTF-8 error

InvalidWsState

Invalid input to WsState::try_from( u16 ).

Fields

supplied: u16

The user supplied value that is invalid.

ConnectionNotOpen

When trying to send and WsState is anything but WsState::Open this error is returned.

InvalidUrl

An invalid URL was given to WsMeta::connect, please see: HTML Living Standard.

Fields

supplied: String

The user supplied value that is invalid.

InvalidCloseCode

An invalid close code was given to a close method. For valid close codes, please see: MDN Documentation.

Fields

supplied: u16

The user supplied value that is invalid.

ReasonStringToLong

The reason string given to a close method is longer than 123 bytes, please see: MDN Documentation.

ConnectionFailed

Failed to connect to the server.

Fields

event: CloseEvent

The close event that might hold extra code and reason information.

InvalidEncoding

When converting the JavaScript Message into a WsMessage, it’s possible that a String message doesn’t convert correctly as Js does not guarantee that strings are valid Unicode. Happens in impl TryFrom< MessageEvent > for WsMessage.

CantDecodeBlob

When converting the JavaScript Message into a WsMessage, it’s not possible to convert Blob type messages, as Blob is a streaming type, that needs to be read asynchronously. If you are using the type without setting up the connection with WsMeta::connect, you have to make sure to set the binary type of the connection to ArrayBuffer.

Happens in impl TryFrom< MessageEvent > for WsMessage.

UnknownDataType

When converting the JavaScript Message into a WsMessage, the data type was neither Arraybuffer, String nor Blob. This should never happen. If it does, please try to make a reproducible example and file an issue.

Happens in impl TryFrom< MessageEvent > for WsMessage.

Dom(u16)

Other(String)

Trait Implementations

impl Clone for WsErr

fn clone(&self) -> WsErr

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WsErr

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

Formats the value using the given formatter.

impl Display for WsErr

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

Formats the value using the given formatter.

impl Error for WsErr

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<Utf8Error> for WsErr

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.

impl PartialEq for WsErr

fn eq(&self, other: &WsErr) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WsErr

impl StructuralPartialEq for WsErr