Enum WebSocketError 

pub enum WebSocketError {
    Connection(String),
    Send(String),
    Receive(String),
    Protocol(String),
    Internal(String),
    Timeout(Duration),
    ReconnectFailed(u32),
    BinaryPayload(String),
    HeartbeatTimeout(Duration),
    SlowConsumer(Duration),
}

Variants

Connection(String)

Send(String)

Receive(String)

Protocol(String)

Internal(String)

Timeout(Duration)

ReconnectFailed(u32)

BinaryPayload(String)

HeartbeatTimeout(Duration)

SlowConsumer(Duration)

Implementations

impl WebSocketError

pub fn client_message(&self) -> &'static str

Returns a sanitized error message safe for client-facing communication.

Internal details (buffer sizes, queue depths, connection state, type names) are stripped to prevent information leakage.

pub fn internal_detail(&self) -> String

Returns the internal detail message for logging purposes.

This MUST NOT be sent to clients as it may contain sensitive internal state information.

Trait Implementations

impl Debug for WebSocketError

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

Formats the value using the given formatter.

impl Display for WebSocketError

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

Formats the value using the given formatter.

impl Error for WebSocketError

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<WebSocketError> for RoomError

fn from(source: WebSocketError) -> Self

Converts to this type from the input type.