Struct SocketCloseCode 

pub struct SocketCloseCode(pub u16);

Wrapper type around a CloseEvent code, indicating why the WebSocket was closed

(JavaScript docs)

Tuple Fields

0: u16

Implementations

impl SocketCloseCode

pub const NORMAL_CLOSURE: SocketCloseCode

Normal closure; the connection successfully completed whatever purpose for which it was created.

pub const GOING_AWAY: SocketCloseCode

The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.

pub const PROTOCOL_ERROR: SocketCloseCode

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

pub const UNSUPPORTED_DATA: SocketCloseCode

The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).

pub const NO_STATUS_RECEIVED: SocketCloseCode

Reserved. Indicates that no status code was provided even though one was expected.

pub const ABNORMAL_CLOSURE: SocketCloseCode

Reserved. Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.

pub const INVALID_FRAME_PAYLOAD_DATA: SocketCloseCode

The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).

pub const POLICY_VIOLATION: SocketCloseCode

The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.

pub const MESSAGE_TOO_BIG: SocketCloseCode

The endpoint is terminating the connection because a data frame was received that is too large.

pub const MISSING_EXTENSION: SocketCloseCode

The client is terminating the connection because it expected the server to negotiate one or more extensions, but the server didn’t.

pub const INTERNAL_ERROR: SocketCloseCode

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

pub const SERVICE_RESTART: SocketCloseCode

The server is terminating the connection because it is restarting.

pub const TRY_AGAIN_LATER: SocketCloseCode

The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients.

pub const BAD_GATEWAY: SocketCloseCode

The server was acting as a gateway or proxy and received an invalid response from the upstream server. This is similar to 502 HTTP Status Code.

pub const TLS_HANDSHAKE: SocketCloseCode

Reserved. Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can’t be verified).

Trait Implementations

impl Clone for SocketCloseCode

fn clone(&self) -> SocketCloseCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketCloseCode

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

Formats the value using the given formatter.

impl Hash for SocketCloseCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SocketCloseCode

fn cmp(&self, other: &SocketCloseCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SocketCloseCode

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

fn partial_cmp(&self, other: &SocketCloseCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SocketCloseCode

impl Eq for SocketCloseCode

impl StructuralPartialEq for SocketCloseCode