Enum WebSocketMessage 

pub enum WebSocketMessage {
    Text(String),
    Binary(Vec<u8>),
    Close {
        code: u16,
        reason: Option<String>,
    },
    Ping(Vec<u8>),
    Pong(Vec<u8>),
}

A WebSocket message that can be text or binary.

Variants

Text(String)

A text message.

Binary(Vec<u8>)

A binary message.

Close

A close message with a numeric close code (RFC 6455) and optional reason text.

Common codes: 1000 Normal Closure, 1001 Going Away, 1005 No Status Received, 1006 Abnormal Closure.

Fields

code: u16

RFC 6455 close code.

reason: Option<String>

Optional human-readable reason string.

Ping(Vec<u8>)

A ping message.

Pong(Vec<u8>)

A pong message.

Implementations

impl WebSocketMessage

pub fn as_text(&self) -> Option<&str>

Get the message as text, if it’s a text message.

pub fn as_json(&self) -> Result<Value, String>

Get the message as JSON, if it’s a text message containing JSON.

pub fn as_binary(&self) -> Option<&[u8]>

Get the message as binary, if it’s a binary message.

pub fn is_close(&self) -> bool

Check if this is a close message.

pub fn close_code(&self) -> Option<u16>

Return the close code if this is a close message.

pub fn close_reason(&self) -> Option<&str>

Return the close reason if this is a close message with a reason.

Trait Implementations

impl Clone for WebSocketMessage

fn clone(&self) -> WebSocketMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketMessage

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

Formats the value using the given formatter.

impl Default for WebSocketMessage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSocketMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WebSocketMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.