Enum CloseCode

#[repr(u16)]
pub enum CloseCode {
    NormalClosure = 1_000,
    GoingAway = 1_001,
    ProtocolError = 1_002,
    UnsupportedData = 1_003,
    NoStatusRcvd = 1_005,
    AbnormalClosure = 1_006,
    InvalidFramePayloadData = 1_007,
    PolicyViolation = 1_008,
    MessageTooBig = 1_009,
    MandatoryExt = 1_010,
    InternalError = 1_011,
    ServiceRestart = 1_012,
    TryAgainLater = 1_013,
    BadGateway = 1_014,
    TlsHandshake = 1_015,
    Other(u16),
}

A close code indicating why a WebSocket connection was closed.

Variants

NormalClosure = 1_000

The connection successfully completed the purpose for which it was created.

GoingAway = 1_001

The endpoint is going away, either because of a server failure or a navigation away.

ProtocolError = 1_002

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

UnsupportedData = 1_003

The connection is being terminated because the endpoint received data of a type it cannot accept.

NoStatusRcvd = 1_005

Reserved: Indicates that no status code was provided although one was expected.

AbnormalClosure = 1_006

Reserved: Indicates that a connection was closed abnormally when a status code was expected.

InvalidFramePayloadData = 1_007

The endpoint is terminating the connection because a message has inconsistent data.

PolicyViolation = 1_008

The endpoint is terminating the connection because it received a message that violates its policy.

MessageTooBig = 1_009

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

MandatoryExt = 1_010

The client is terminating the connection because it expected a server extension negotiation.

InternalError = 1_011

The server is terminating the connection because it encountered an unexpected condition.

ServiceRestart = 1_012

The server is terminating the connection because it is restarting.

TryAgainLater = 1_013

The server is terminating the connection due to a temporary condition (e.g., overloaded).

BadGateway = 1_014

The server was acting as a gateway or proxy and received an invalid response from upstream.

TlsHandshake = 1_015

Reserved: The connection was closed due to a failure in the TLS handshake.

Other(u16)

Other close code.

Implementations

impl CloseCode

pub fn is_valid(&self) -> bool

Whether the close code can be specified when closing a WebSocket using WebSocket::close_with_reason.

The close code is valid if it is either CloseCode::NormalClosure or CloseCode::Other with a value between 3000 and 4999.

Trait Implementations

impl Clone for CloseCode

fn clone(&self) -> CloseCode

Returns a duplicate of the value.

const 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 Display for CloseCode

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

Formats the value using the given formatter.

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

Converts to this type from the input type.

impl Hash for CloseCode

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 CloseCode

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

fn eq(&self, other: &CloseCode) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 CloseCode

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

impl Eq for CloseCode

impl StructuralPartialEq for CloseCode