Enum CloseCode 

#[repr(u16)]
pub enum CloseCode {
    Normal = 1_000,
    Away = 1_001,
    ProtocolError = 1_002,
    Unsupported = 1_003,
    NoStatus = 1_005,
    Abnormal = 1_006,
    InvalidPayload = 1_007,
    PolicyViolation = 1_008,
    TooBig = 1_009,
    MandatoryExtension = 1_010,
    Internal = 1_011,
    TlsHandshake = 1_015,
    Application(u16),
}

WebSocket close codes as defined in RFC 6455

Variants

Normal = 1_000

Normal closure

Away = 1_001

Going away

ProtocolError = 1_002

Protocol error

Unsupported = 1_003

Unsupported data

NoStatus = 1_005

No status received

Abnormal = 1_006

Abnormal closure

InvalidPayload = 1_007

Invalid frame payload data

PolicyViolation = 1_008

Policy violation

TooBig = 1_009

Message too big

MandatoryExtension = 1_010

Mandatory extension

Internal = 1_011

Internal server error

TlsHandshake = 1_015

TLS handshake failure

Application(u16)

Application-specific close code

Implementations

impl CloseCode

pub fn from(code: u16) -> CloseCode

Create a CloseCode from a u16

pub fn code(&self) -> u16

Get the numeric value of the close code

pub fn is_reserved(&self) -> bool

Check if this is a reserved close code

pub fn is_error(&self) -> bool

Check if this close code indicates an error

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<(), Error>

Formats the value using the given formatter.

impl Display for CloseCode

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

Formats the value using the given formatter.

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

impl Eq for CloseCode

impl StructuralPartialEq for CloseCode