Struct CloseCode

pub struct CloseCode(/* private fields */);

Close status code.

Implementations

impl CloseCode

pub const NORMAL_CLOSURE: Self

Normal closure, meaning that the purpose for which the connection was established has been fulfilled.

pub const GOING_AWAY: Self

Endpoint is “going away”, such as a server going down or a browser having navigated away from a page.

pub const PROTOCOL_ERROR: Self

Endpoint is terminating the connection due to a protocol error.

pub const UNSUPPORTED_DATA: Self

Endpoint is terminating the connection because it has received a type of data it cannot accept.

pub const NO_STATUS_RECEIVED: Self

No status code was actually present.

pub const INVALID_FRAME_PAYLOAD_DATA: Self

Endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message.

pub const POLICY_VIOLATION: Self

Endpoint is terminating the connection because it has received a message that violates its policy.

pub const MESSAGE_TOO_BIG: Self

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

pub const MANDATORY_EXTENSION: Self

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.

pub const INTERNAL_SERVER_ERROR: Self

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

pub const SERVICE_RESTART: Self

Service is restarted. A client may reconnect, and if it choses to do, should reconnect using a randomized delay of 5–30s.

pub const SERVICE_OVERLOAD: Self

Service is experiencing overload. A client should only connect to a different IP (when there are multiple for the target) or reconnect to the same IP upon user action.

pub const BAD_GATEWAY: Self

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

impl CloseCode

pub fn is_reserved(self) -> bool

Whether the close code is reserved and cannot be sent over the wire.

Trait Implementations

impl Clone for CloseCode

fn clone(&self) -> CloseCode

Returns a duplicate 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 From<CloseCode> for u16

fn from(value: CloseCode) -> 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 TryFrom<u16> for CloseCode

type Error = ProtocolError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for CloseCode

impl Eq for CloseCode

impl StructuralPartialEq for CloseCode