Enum CloseCode

#[non_exhaustive]
pub enum CloseCode {
    Normal,
    Away,
    Protocol,
    Unsupported,
    Status,
    Abnormal,
    Invalid,
    Policy,
    Size,
    Extension,
    Error,
    Restart,
    Again,
    Tls,
    Reserved(u16),
    Iana(u16),
    Library(u16),
    Bad(u16),
}

Status code used to indicate why an endpoint is closing the WebSocket connection.1

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Normal

Indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.

Away

Indicates that an endpoint is “going away”, such as a server going down or a browser having navigated away from a page.

Protocol

Indicates that an endpoint is terminating the connection due to a protocol error.

Unsupported

Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).

Status

Indicates that no status code was included in a closing frame. This close code makes it possible to use a single method, on_close to handle even cases where no close code was provided.

Abnormal

Indicates an abnormal closure. If the abnormal closure was due to an error, this close code will not be used. Instead, the on_error method of the handler will be called with the error. However, if the connection is simply dropped, without an error, this close code will be sent to the handler.

Invalid

Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message).

Policy

Indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code that can be returned when there is no other more suitable status code (e.g., Unsupported or Size) or if there is a need to hide specific details about the policy.

Size

Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.

Extension

Indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn’t return them in the response message of the WebSocket handshake. The list of extensions that are needed should be given as the reason for closing. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.

Error

Indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

Restart

Indicates that the server is restarting. A client may choose to reconnect, and if it does, it should use a randomized delay of 5-30 seconds between attempts.

Again

Indicates that the server is overloaded and the client should either connect to a different IP (when multiple targets exist), or reconnect to the same IP when a user has performed an action.

Tls

Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can’t be verified). This is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.

Reserved(u16)

Reserved status codes.

Iana(u16)

Reserved for use by libraries, frameworks, and applications. These status codes are registered directly with IANA. The interpretation of these codes is undefined by the WebSocket protocol.

Library(u16)

Reserved for private use. These can’t be registered and can be used by prior agreements between WebSocket applications. The interpretation of these codes is undefined by the WebSocket protocol.

Bad(u16)

Unused / invalid status codes.

Implementations

impl CloseCode

pub const fn is_allowed(self) -> bool

Check if this CloseCode is allowed.

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

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

Formats the value using the given formatter.

impl Default for CloseCode

fn default() -> CloseCode

Returns the “default value” for a type.

impl Display for CloseCode

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

Formats the value using the given formatter.

impl From<CloseCode> for CloseCode

fn from(value: CloseCode) -> Self

Converts to this type from the input type.

impl From<CloseCode> for CloseCode

fn from(value: CloseCode) -> Self

Converts to this type from the input type.

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(code: u16) -> Self

Converts to this type from the input type.

impl PartialEq for CloseCode

fn eq(&self, other: &CloseCode) -> 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

impl Eq for CloseCode

impl StructuralPartialEq for CloseCode