Enum Error

pub enum Error<I, O>
where
    I: SocketInput,
    O: SocketOutput,
    Message: TryFrom<I>,
    <Message as TryFrom<I>>::Error: Debug,
    <O as TryFrom<Message>>::Error: Debug,
{
    WebSocketError(WebSocketError),
    JsError(JsError),
    InvalidConfig(String),
    InputError(<Message as TryFrom<I>>::Error),
    OutputError(<O as TryFrom<Message>>::Error),
}

Errors returned by crate::Socket and crate::SocketBuilder

Variants

WebSocketError(WebSocketError)

Errors from the underlying gloo::net::websocket::futures::WebSocket

These are unlikely to be fatal, they mostly express various ways the websocket has disconnected or encountered an error that requires reconnecting

JsError(JsError)

Javascript errors returned by either crate::get_proto_and_host or the underlying gloo::net::websocket::futures::WebSocket

These errors are often fatal errors like the URL provided is invalid, the port is firewalled or other miscellaneous errors from the browser. Look at gloo::net::websocket::futures::WebSocket::open to work out what the cases are and how to handle them

InvalidConfig(String)

Invalid configuration provided to crate::SocketBuilder

These errors are only returned from the bulder and are all fatal

InputError(<Message as TryFrom<I>>::Error)

Input errors returned by the consumers implementation of <crate::Message as TryFrom<I>>

If these errors are fatal is dependent on consumers implementation of TryFrom<I>

OutputError(<O as TryFrom<Message>>::Error)

Output errors returned by the consumers implementation of <O as TryFrom<Message>>

If these errors are fatal is dependent on consumers implementation of TryFrom<Message>

Trait Implementations

impl<I, O> Debug for Error<I, O>

where I: SocketInput + Debug, O: SocketOutput + Debug, Message: TryFrom<I>, <Message as TryFrom<I>>::Error: Debug, <O as TryFrom<Message>>::Error: Debug,

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

Formats the value using the given formatter.

impl<I, O> Display for Error<I, O>

where I: SocketInput, O: SocketOutput, Message: TryFrom<I>, <Message as TryFrom<I>>::Error: Debug + Debug, <O as TryFrom<Message>>::Error: Debug,

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

Formats the value using the given formatter.

impl<I, O> Error for Error<I, O>

where I: SocketInput, O: SocketOutput, Message: TryFrom<I>, <Message as TryFrom<I>>::Error: Debug, <O as TryFrom<Message>>::Error: Debug, Self: Debug + Display,

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<I, O> From<JsError> for Error<I, O>

where I: SocketInput, O: SocketOutput, Message: TryFrom<I>, <Message as TryFrom<I>>::Error: Debug, <O as TryFrom<Message>>::Error: Debug,

fn from(source: JsError) -> Self

Converts to this type from the input type.

impl<I, O> From<WebSocketError> for Error<I, O>

where I: SocketInput, O: SocketOutput, Message: TryFrom<I>, <Message as TryFrom<I>>::Error: Debug, <O as TryFrom<Message>>::Error: Debug,

fn from(err: WebSocketError) -> Self

Converts to this type from the input type.