Struct Message 

pub struct Message {
    pub message_type: MessageType,
    pub payload: Bytes,
}

A WebSocket message.

Fields

message_type: MessageType

The message type

payload: Bytes

The message payload

Implementations

impl Message

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

Create a new text message.

pub fn binary<B: Into<Bytes>>(data: B) -> Self

Create a new binary message.

pub fn ping<B: Into<Bytes>>(data: B) -> Self

Create a new ping message.

pub fn pong<B: Into<Bytes>>(data: B) -> Self

Create a new pong message.

pub fn close() -> Self

Create a close message.

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

Create a JSON message from a serializable value.

pub fn parse_json<'a, T: Deserialize<'a>>(&'a self) -> Result<T, Error>

Parse the message payload as JSON.

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

Get the message payload as a string.

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

Get the message payload as bytes.

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.

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<Message> for Message

fn from(msg: Message) -> Self

Converts to this type from the input type.

impl From<Message> for Message

fn from(msg: Message) -> Self

Converts to this type from the input type.