Enum CloseCode 

#[repr(u16)]
pub enum CloseCode {
    Normal = 1_000,
    GoingAway = 1_001,
    ProtocolError = 1_002,
    UnsupportedData = 1_003,
    NoStatusReceived = 1_005,
    AbnormalClosure = 1_006,
    InvalidPayloadData = 1_007,
    PolicyViolation = 1_008,
    MessageTooBig = 1_009,
    MandatoryExtension = 1_010,
    InternalError = 1_011,
    ServiceRestart = 1_012,
    TryAgainLater = 1_013,
    BadGateway = 1_014,
    TlsHandshakeFailure = 1_015,
}

Close-Status-Code (RFC 6455 §7.4.1 + §7.4.2).

Variants

Normal = 1_000

1000 Normal Closure.

GoingAway = 1_001

1001 Going Away.

ProtocolError = 1_002

1002 Protocol Error.

UnsupportedData = 1_003

1003 Unsupported Data.

NoStatusReceived = 1_005

1005 No Status Received (reserved, NOT on the wire).

AbnormalClosure = 1_006

1006 Abnormal Closure (reserved, NOT on the wire).

InvalidPayloadData = 1_007

1007 Invalid Frame Payload Data (UTF-8).

PolicyViolation = 1_008

1008 Policy Violation.

MessageTooBig = 1_009

1009 Message Too Big.

MandatoryExtension = 1_010

1010 Mandatory Extension (Client only).

InternalError = 1_011

1011 Internal Error.

ServiceRestart = 1_012

1012 Service Restart.

TryAgainLater = 1_013

1013 Try Again Later.

BadGateway = 1_014

1014 Bad Gateway.

TlsHandshakeFailure = 1_015

1015 TLS Handshake Failure (reserved, NOT on the wire).

Implementations

impl CloseCode

pub const fn to_u16(self) -> u16

Wire value.

pub const fn from_u16(v: u16) -> Result<Self, ()>

u16 -> CloseCode.

Errors

() if the code is unknown or reserved-but-not-handled.

pub const fn is_reserved(self) -> bool

Spec §7.4.2: codes 1004, 1005, 1006, 1015 are reserved and must NOT appear on 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 Copy for CloseCode

impl Debug for CloseCode

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

Formats the value using the given formatter.

impl Eq for CloseCode

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 StructuralPartialEq for CloseCode