Enum WebSocketCloseCode 

#[repr(u16)]
pub enum WebSocketCloseCode {
    Clean = 1_000,
    Leaving = 1_001,
    ProtocolError = 1_002,
    Error = 1_011,
    AuthFailed = 4_106,
    AuthTimeout = 4_107,
    Kicked = 4_108,
    RoomFull = 4_109,
}

websocket close code vocabulary shared by server and browser protocol code

standard codes keep their RFC meaning custom codes mirror the legacy Odoo SFU websocket close vocabulary used by browser clients and low-cardinality telemetry

Variants

Clean = 1_000

normal websocket closure

Leaving = 1_001

the peer is leaving

ProtocolError = 1_002

the peer sent a malformed or invalid protocol message

Error = 1_011

the server hit an internal error while handling the socket

AuthFailed = 4_106

authentication failed

AuthTimeout = 4_107

the client did not authenticate before the server timeout

Kicked = 4_108

the runtime removed this client from the room

RoomFull = 4_109

admission failed because the room cannot accept another user

Implementations

impl WebSocketCloseCode

pub const fn from_u16(value: u16) -> Option<Self>

decode a raw websocket close code if it belongs to the shared vocabulary

unknown codes return None so the caller can keep foreign websocket close reasons out of application telemetry labels and protocol state machines

Trait Implementations

impl Clone for WebSocketCloseCode

fn clone(&self) -> WebSocketCloseCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebSocketCloseCode

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

Formats the value using the given formatter.

impl From<WebSocketCloseCode> for u16

fn from(value: WebSocketCloseCode) -> Self

Converts to this type from the input type.

impl PartialEq for WebSocketCloseCode

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

impl Eq for WebSocketCloseCode

impl StructuralPartialEq for WebSocketCloseCode