Enum WebSocketError 

pub enum WebSocketError {
    Custom(String),
    JsValue(Sendable<Printable>),
    PoisonError,
    MissingUrl,
    AddressSchema(String),
    InvalidMessageType,
    InvalidState(u16),
    DataEncoding,
    DataType,
    AlreadyInitialized,
    AlreadyConnected,
    NotConnected,
    Connect(String),
    NegotiationFailure,
    DispatchChannelAck,
    ChannelSend,
    DispatchChannelTrySend,
    DispatcherSignal,
    ReceiveChannel,
    ConnectChannel,
    Callback(CallbackError),
    Task(TaskError),
    Tungstenite(Box<Error>),
    ReceiverCtlSend(SendError<Message>),
    WorkflowWasm(Error),
    ConnectionTimeout,
    InvalidConnectStrategyArg(String),
    InvalidConnectStrategy,
}

Errors produced by the WebSocket client.

Variants

Custom(String)

A custom, free-form error message.

JsValue(Sendable<Printable>)

An error originating from the JavaScript/WASM boundary.

PoisonError

A mutex was poisoned due to a panic in another thread.

MissingUrl

No URL was supplied via the constructor, connect(), or a resolver.

AddressSchema(String)

The supplied URL does not use the ws:// or wss:// scheme.

InvalidMessageType

A received message was of an unsupported or unexpected type.

InvalidState(u16)

The socket was in an invalid ready state (value carried) for the operation.

DataEncoding

Message payload could not be encoded.

DataType

The message data was of an unexpected type.

AlreadyInitialized

The connection has already been initialized.

AlreadyConnected

The WebSocket is already connected.

NotConnected

The WebSocket is not currently connected.

Connect(String)

Connection to the given URL could not be established.

NegotiationFailure

The custom handshake negotiation failed.

DispatchChannelAck

Failed to receive an acknowledgement on the dispatch channel.

ChannelSend

A channel send operation failed.

DispatchChannelTrySend

A non-blocking dispatch channel try_send failed.

DispatcherSignal

Failed to signal the dispatcher task.

ReceiveChannel

The receive channel failed.

ConnectChannel

The connect-notification channel failed.

Callback(CallbackError)

An error originating from a WASM callback.

Task(TaskError)

An error originating from the task subsystem.

Tungstenite(Box<Error>)

An error from the native tungstenite WebSocket implementation.

ReceiverCtlSend(SendError<Message>)

Failed to relay a control message to the receiver.

WorkflowWasm(Error)

An error originating from the workflow-wasm crate.

ConnectionTimeout

The connection attempt timed out.

InvalidConnectStrategyArg(String)

The supplied connect-strategy argument was invalid.

InvalidConnectStrategy

The configured connect strategy was invalid.

Implementations

impl Error

pub fn custom<T>(message: T) -> Error

where T: Display,

Construct a Error::Custom error from any displayable value.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<&str> for Error

fn from(error: &str) -> Error

Converts to this type from the input type.

impl From<CallbackError> for Error

fn from(source: CallbackError) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

Available on non-WebAssembly only.

fn from(error: Error) -> Error

Converts to this type from the input type.

impl From<Error> for JsValue

fn from(error: Error) -> JsValue

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: WebSocketError) -> Self

Converts to this type from the input type.

impl From<Error> for ServerError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<JsValue> for Error

fn from(error: JsValue) -> Error

Converts to this type from the input type.

impl<T> From<PoisonError<T>> for Error

fn from(_: PoisonError<T>) -> Error

Converts to this type from the input type.

impl From<RecvError> for Error

fn from(_: RecvError) -> Error

Converts to this type from the input type.

impl<T> From<SendError<T>> for Error

fn from(_error: SendError<T>) -> Error

Converts to this type from the input type.

impl From<String> for Error

fn from(error: String) -> Error

Converts to this type from the input type.

impl From<TaskError> for Error

fn from(source: TaskError) -> Error

Converts to this type from the input type.

impl<T> From<TrySendError<T>> for Error

fn from(_error: TrySendError<T>) -> Error

Converts to this type from the input type.