Enum websocket::OwnedMessage

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

Represents an owned WebSocket message.

OwnedMessages are generated when the user receives a message (since the data has to be copied out of the network buffer anyway). If you would like to create a message out of borrowed data to use for sending please use the Message struct (which contains a Cow).

Note that OwnedMessage and Message can be converted into each other.

Variants

Text(String)

A message containing UTF-8 text data

Binary(Vec<u8>)

A message containing binary data

Close(Option<CloseData>)

A message which indicates closure of the WebSocket connection. This message may or may not contain data.

Ping(Vec<u8>)

A ping message - should be responded to with a pong message. Usually the pong message will be sent with the same data as the received ping message.

Pong(Vec<u8>)

A pong message, sent in response to a Ping message, usually containing the same data as the received ping message.

Implementations

impl OwnedMessage

pub fn is_close(&self) -> bool

Checks if this message is a close message.

assert!(OwnedMessage::Close(None).is_close());

pub fn is_control(&self) -> bool

Checks if this message is a control message. Control messages are either Close, Ping, or Pong.

assert!(OwnedMessage::Ping(vec![]).is_control());
assert!(OwnedMessage::Pong(vec![]).is_control());
assert!(OwnedMessage::Close(None).is_control());

pub fn is_data(&self) -> bool

Checks if this message is a data message. Data messages are either Text or Binary.

assert!(OwnedMessage::Text("1337".to_string()).is_data());
assert!(OwnedMessage::Binary(vec![]).is_data());

pub fn is_ping(&self) -> bool

Checks if this message is a ping message. Ping messages can come at any time and usually generate a Pong message response.

assert!(OwnedMessage::Ping("ping".to_string().into_bytes()).is_ping());

pub fn is_pong(&self) -> bool

Checks if this message is a pong message. Pong messages are usually sent only in response to Ping messages.

assert!(OwnedMessage::Pong("pong".to_string().into_bytes()).is_pong());

Trait Implementations

impl Clone for OwnedMessage

fn clone(&self) -> OwnedMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DataFrame for OwnedMessage

fn is_last(&self) -> bool

Is this dataframe the final dataframe of the message?

fn opcode(&self) -> u8

What type of data does this dataframe contain?

fn reserved(&self) -> &[bool; 3]

Reserved bits of this dataframe

fn size(&self) -> usize

How long (in bytes) is this dataframe’s payload

fn write_payload(&self, socket: &mut dyn Write) -> Result<(), WebSocketError>

Write the payload to a writer

fn take_payload(self) -> Vec<u8>

Takes the payload out into a vec

fn frame_size(&self, masked: bool) -> usize

Get’s the size of the entire dataframe in bytes, i.e. header and payload.

fn write_to( &self, writer: &mut dyn Write, mask: bool ) -> Result<(), WebSocketError>

Writes a DataFrame to a Writer.

impl Debug for OwnedMessage

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

Formats the value using the given formatter.

impl<'m> From<Message<'m>> for OwnedMessage

fn from(message: Message<'m>) -> OwnedMessage

Converts to this type from the input type.

impl<'m> From<OwnedMessage> for Message<'m>

fn from(message: OwnedMessage) -> Message<'m>

Converts to this type from the input type.

impl From<String> for OwnedMessage

fn from(text: String) -> OwnedMessage

Converts to this type from the input type.

impl From<Vec<u8>> for OwnedMessage

fn from(buf: Vec<u8>) -> OwnedMessage

Converts to this type from the input type.

impl Message for OwnedMessage

fn serialize( &self, writer: &mut dyn Write, masked: bool ) -> Result<(), WebSocketError>

Attempt to form a message from a series of data frames

fn message_size(&self, masked: bool) -> usize

Returns how many bytes this message will take up

fn from_dataframes<D>(frames: Vec<D>) -> Result<OwnedMessage, WebSocketError>

where D: DataFrame,

Attempt to form a message from a series of data frames

impl PartialEq for OwnedMessage

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OwnedMessage

impl StructuralPartialEq for OwnedMessage