Enum Message 

pub enum Message {
    Text(Utf8Bytes),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close(Option<CloseFrame>),
    Frame(Frame),
}

A WebSocket message

Variants

Text(Utf8Bytes)

A text message

Binary(Bytes)

A binary message

Ping(Bytes)

A ping (control) message

Pong(Bytes)

A pong (control) message

Close(Option<CloseFrame>)

A close (control) message

Frame(Frame)

Raw frame

Implementations

impl Message

pub fn new_text<S>(string: S) -> Message

where S: Into<Utf8Bytes>,

Create a new text WebSocket message from a stringable.

pub fn new_binary<B>(binary: B) -> Message

where B: Into<Bytes>,

Create a new binary WebSocket message by converting to Bytes.

pub fn is_control(&self) -> bool

Indicates if the Message is of control protocol (Ping, Pong, Close)

pub fn is_data(&self) -> bool

Indicates if the Message is of data protocol (Text, Binary)

pub fn is_text(&self) -> bool

Indicates if the Message is of Text protocol

pub fn is_binary(&self) -> bool

Indicates if the Message is of Binary protocol

pub fn len(&self) -> usize

Get the length of the WebSocket message.

pub fn is_empty(&self) -> bool

Returns true if the WebSocket message has no content. For example, if the other side of the connection sent an empty string.

pub fn into_data(self) -> Bytes

Parses the message data

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

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

Formats the value using the given formatter.

impl<'b> From<&'b [u8]> for Message

fn from(value: &'b [u8]) -> Self

Converts to this type from the input type.

impl<'s> From<&'s str> for Message

fn from(value: &'s str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Message

fn from(value: Bytes) -> Self

Converts to this type from the input type.

impl From<Message> for Bytes

fn from(value: Message) -> Self

Converts to this type from the input type.

impl From<String> for Message

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Message

fn from(value: 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