Struct CloseCode 

pub struct CloseCode(pub u16);

A close status code.

A newtype rather than an enum because the range 3000–4999 belongs to the application and must survive a round trip unchanged.

Tuple Fields

0: u16

Implementations

impl CloseCode

pub const NORMAL: CloseCode

pub const GOING_AWAY: CloseCode

pub const PROTOCOL_ERROR: CloseCode

pub const UNSUPPORTED: CloseCode

pub const NO_STATUS: CloseCode

Never sent on the wire: it means “the peer closed without a code”.

pub const ABNORMAL: CloseCode

Never sent on the wire: it means “the connection died”.

pub const INVALID_PAYLOAD: CloseCode

pub const POLICY: CloseCode

pub const TOO_LARGE: CloseCode

pub const INTERNAL_ERROR: CloseCode

pub fn code(self) -> u16

pub fn is_sendable(self) -> bool

Whether this code is one a peer is allowed to put in a close frame.

1005, 1006 and 1015 describe how a connection ended locally; sending one is a protocol violation, and clients do occasionally try.

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CloseCode