Struct ws_tool::protocol::StatusCode

pub struct StatusCode;

helper struct for using close code

Implementations

impl StatusCode

pub fn normal() -> u16

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

pub fn going_away() -> u16

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

pub fn protocol_error() -> u16

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

pub fn terminate() -> u16

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

pub fn reserved() -> u16

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

pub fn app_reserved() -> u16

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.

pub fn abnormal_reserved() -> u16

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.

pub fn non_consistent() -> u16

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

pub fn violate_policy() -> u16

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.

pub fn too_big() -> u16

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

pub fn require_ext() -> u16

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.

pub fn unexpected_condition() -> u16

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

pub fn platform_fail() -> u16

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