Enum Message 

pub enum Message {
    Text(String),
    Binary(Vec<u8>),
    Ping(Vec<u8>),
    Pong(Vec<u8>),
    Close(Option<CloseFrame>),
}

WebSocket message types

Variants

Text(String)

UTF-8 text message

Binary(Vec<u8>)

Binary message

Ping(Vec<u8>)

Ping message (client should respond with Pong)

Pong(Vec<u8>)

Pong message (response to Ping)

Close(Option<CloseFrame>)

Close message with optional code and reason

Implementations

impl Message

pub fn text(s: impl Into<String>) -> Self

Create a text message

pub fn binary(data: impl Into<Vec<u8>>) -> Self

Create a binary message

pub fn ping(data: impl Into<Vec<u8>>) -> Self

Create a ping message

pub fn pong(data: impl Into<Vec<u8>>) -> Self

Create a pong message

pub fn close(code: CloseCode, reason: impl Into<String>) -> Self

Create a close message

pub fn is_text(&self) -> bool

Check if this is a text message

pub fn is_binary(&self) -> bool

Check if this is a binary message

pub fn is_ping(&self) -> bool

Check if this is a ping message

pub fn is_pong(&self) -> bool

Check if this is a pong message

pub fn is_close(&self) -> bool

Check if this is a close message

pub fn is_data(&self) -> bool

Check if this is a data message (text or binary)

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

Get the text content if this is a text message

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

Get the binary content if this is a binary message

pub fn into_text(self) -> Option<String>

Convert to text (consumes the message)

pub fn into_bytes(self) -> Option<Vec<u8>>

Convert to bytes (consumes the message)

pub fn len(&self) -> usize

Get the payload length

pub fn is_empty(&self) -> bool

Check if the payload is empty

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl PartialEq for Message

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

impl StructuralPartialEq for Message