Enum web_socket::CloseEvent

pub enum CloseEvent {
    Error(&'static str),
    Close {
        code: u16,
        reason: Box<str>,
    },
}

The CloseEvent enum represents the possible events that can occur when a WebSocket connection is closed. It has two variants: Error and Close.

Variants

Error(&'static str)

represents the websocket error message.

Close

Fields

code: u16

represents the status CloseCode of the close event.

reason: Box<str>

represents the reason for the close event

represents a successful close event of the WebSocket connection.

Trait Implementations

impl Debug for CloseEvent

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

Formats the value using the given formatter.

impl Display for CloseEvent

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

Formats the value using the given formatter.

impl Error for CloseEvent

fn source(&self) -> Option<&(dyn Error + 'static)>

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, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.