Enum web_socket::CloseCode

pub enum CloseCode {
    Normal,
    Away,
    ProtocolError,
    Unsupported,
    NoStatusRcvd,
    Abnormal,
    InvalidPayload,
    PolicyViolation,
    MessageTooBig,
    MandatoryExt,
    InternalError,
    TLSHandshake,
}

When closing an established connection an endpoint MAY indicate a reason for closure.

Variants

Normal

The purpose for which the connection was established has been fulfilled

Away

Server going down or a browser having navigated away from a page

ProtocolError

An endpoint is terminating the connection due to a protocol error.

Unsupported

It has received a type of data it cannot accept

NoStatusRcvd

MUST NOT be set as a status code in a Close control frame by an endpoint.

No status code was actually present.

Abnormal

MUST NOT be set as a status code in a Close control frame by an endpoint.

Connection was closed abnormally.

InvalidPayload

Application has received data within a message that was not consistent with the type of the message.

PolicyViolation

This is a generic status code that can be returned when there is no other more suitable status code.

MessageTooBig

Message that is too big for it to process.

MandatoryExt

It has expected the server to negotiate one or more extension.

InternalError

The server has encountered an unexpected condition that prevented it from fulfilling the request.

TLSHandshake

MUST NOT be set as a status code in a Close control frame by an endpoint.

The connection was closed due to a failure to perform a TLS handshake.

Trait Implementations

impl Clone for CloseCode

fn clone(&self) -> CloseCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CloseFrame for CloseCode

type Frame = Vec<u8, Global>

Serialized close frame

fn encode<const SIDE: bool>(self) -> Self::Frame

Encode websocket close frame.

impl Debug for CloseCode

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

Formats the value using the given formatter.

impl From<CloseCode> for u16

fn from(code: CloseCode) -> Self

Converts to this type from the input type.

impl From<u16> for CloseCode

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Copy for CloseCode