Enum Message

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

A received WebSocket frame.

Variants

Text

A text message.

Note

RFC6455 is not strict as to when UTF-8 validation takes place. As such, Ratchet opts to not validate the text payload and leaves it to the user to validate it once the message has been received.

Binary

A binary message.

Ping(Bytes)

A ping message.

Pong(Bytes)

A pong message.

Close(Option<CloseReason>)

A close message.

Implementations

impl Message

pub fn is_text(&self) -> bool

Whether this is a text message.

pub fn is_binary(&self) -> bool

Whether this is a binary message.

pub fn is_ping(&self) -> bool

Whether this is a ping message.

pub fn is_pong(&self) -> bool

Whether this is a pong message.

pub fn is_close(&self) -> bool

Whether 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 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