Enum CloseCode

pub enum CloseCode {
    Normal = 1_000,
    Away = 1_001,
    ProtocolError = 1_002,
    Unsupported = 1_003,
    NoStatusRcvd = 1_005,
    Abnormal = 1_006,
    InvalidPayload = 1_007,
    PolicyViolation = 1_008,
    MessageTooBig = 1_009,
    MandatoryExt = 1_010,
    InternalError = 1_011,
    TLSHandshake = 1_015,
}

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

Variants

Normal = 1_000

The purpose for which the connection was established has been fulfilled

Away = 1_001

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

ProtocolError = 1_002

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

Unsupported = 1_003

It has received a type of data it cannot accept

NoStatusRcvd = 1_005

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

No status code was actually present.

Abnormal = 1_006

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

Connection was closed abnormally.

InvalidPayload = 1_007

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

PolicyViolation = 1_008

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

MessageTooBig = 1_009

Message that is too big for it to process.

MandatoryExt = 1_010

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

InternalError = 1_011

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

TLSHandshake = 1_015

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 CloseReason for CloseCode

type Bytes = [u8; 2]

Encoded close reason as bytes

fn to_bytes(self) -> Self::Bytes

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 PartialEq<u16> for CloseCode

fn eq(&self, other: &u16) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CloseCode