Enum Message 

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

WebSocket message type

Variants

Text(String)

Text message (UTF-8 encoded)

Binary(Vec<u8>)

Binary message

Ping(Vec<u8>)

Ping message

Pong(Vec<u8>)

Pong message

Close(Option<CloseFrame>)

Close message

Implementations

impl Message

pub fn text(text: 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() -> Self

Create a close message

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

Create a close message with a frame

pub fn json<T: Serialize>(value: &T) -> Result<Self, WebSocketError>

Create a JSON text message from a serializable type

pub fn as_json<T: DeserializeOwned>(&self) -> Result<T, WebSocketError>

Try to deserialize a text message as JSON

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 as_text(&self) -> Option<&str>

Get the text content if this is a text message

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

Get the binary content if this is a binary message

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

Convert to text, consuming the message

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

Convert to bytes, consuming the message

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 From<&[u8]> for Message

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Message

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<Message> for Message

Convert from tungstenite Message

fn from(msg: Message) -> Self

Converts to this type from the input type.

impl From<Message> for Message

Convert to tungstenite Message

fn from(msg: Message) -> Self

Converts to this type from the input type.

impl From<String> for Message

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Message

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

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