Enum ws_tool::protocol::StatusCode

pub enum StatusCode {
    C1000,
    C1001,
    C1002,
    C1003,
    C1004,
    C1005,
    C1006,
    C1007,
    C1008,
    C1009,
    C1010,
    C1011,
    C1015,
    C0_999,
    C1000_2999,
    C3000_3999,
    C4000_4999,
    Unknown,
}

close status code to indicate reason for closure

Variants

C1000

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

C1001

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

C1002

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

C1003

1003 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).

C1004

Reserved. The specific meaning might be defined in the future.

C1005

1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that no status code was actually present.

C1006

1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame.

C1007

1007 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).

C1008

1008 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., 1003 or 1009) or if there is a need to hide specific details about the policy.

C1009

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

C1010

1010 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 appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.

C1011

1011 indicates that a server is terminating the connection because it encountered an

C1015

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

C0_999

Status codes in the range 0-999 are not used.

C1000_2999

C3000_3999

Status codes in the range 3000-3999 are reserved for use by libraries, frameworks, and applications. These status codes are registered directly with IANA. The interpretation of these codes is undefined by this protocol.

C4000_4999

Status codes in the range 4000-4999 are reserved for private use and thus can’t be registered. Such codes can be used by prior agreements between WebSocket applications. The interpretation of these codes is undefined by this protocol.

Unknown

Trait Implementations

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StatusCode

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

Formats the value using the given formatter.