Enum Message 

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

One WebSocket frame’s payload.

Ping and pong are not here. They are keep-alive, the transport answers them, and a handler that had to remember to reply to a ping would have a connection that dies when it forgets.

Variants

Text(String)

A text frame. UTF-8 by definition of the protocol.

Binary(Vec<u8>)

A binary frame.

Close(Option<String>)

The peer is closing, with an optional reason.

Delivered to on_message only if a handler asked for it; on_close is the usual place.

Implementations

impl Message

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

A text frame.

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

A binary frame.

pub fn json(value: &impl Serialize) -> Result<Self>

A text frame holding value as JSON — how nearly every application actually talks over a socket.

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

The text, if this is a text frame.

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

The bytes, whichever kind of frame this is.

pub fn parse_json(&self) -> Result<Value>

Parse a text frame as JSON.

A bad request, not an internal error: the bytes came from a client, and a client that sends nonsense is not a bug in your handler.

pub fn is_close(&self) -> bool

Whether this is the peer closing.

pub fn len(&self) -> usize

How many bytes the payload is.

pub fn is_empty(&self) -> bool

Whether the payload is empty.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Self

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

impl From<&str> for Message

fn from(text: &str) -> 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(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl PartialEq for Message

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Message