Enum websocket::OwnedMessage

[−] Show declaration

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

[−] Expand description

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)

[−] Expand description

A message containing UTF-8 text data

Binary(Vec<u8, Global>)

[−] Expand description

A message containing binary data

Close(Option<CloseData>)

[−] Expand description

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

Ping(Vec<u8, Global>)

[−] Expand description

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, Global>)

[−] Expand description

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[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> OwnedMessage[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl DataFrame for OwnedMessage[+]

[+] Show hidden undocumented items

pub fn is_last(&self) -> bool[−]

Is this dataframe the final dataframe of the message?

pub fn opcode(&self) -> u8[−]

What type of data does this dataframe contain?

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

Reserved bits of this dataframe

pub fn size(&self) -> usize[−]

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

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

Write the payload to a writer

pub fn take_payload(self) -> Vec<u8, Global>[−]

Takes the payload out into a vec

pub fn frame_size(&self, masked: bool) -> usize[−]

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

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

Writes a DataFrame to a Writer.

impl Debug for OwnedMessage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for OwnedMessage

impl<'m> From<Message<'m>> for OwnedMessage[+]

[+] Show hidden undocumented items

pub fn from(message: Message<'m>) -> OwnedMessage[−]

Performs the conversion.

impl<'m> From<OwnedMessage> for Message<'m>[+]

[+] Show hidden undocumented items

pub fn from(message: OwnedMessage) -> Message<'m>[−]

Performs the conversion.

impl From<String> for OwnedMessage[+]

[+] Show hidden undocumented items

pub fn from(text: String) -> OwnedMessage[−]

Performs the conversion.

impl From<Vec<u8, Global>> for OwnedMessage[+]

[+] Show hidden undocumented items

pub fn from(buf: Vec<u8, Global>) -> OwnedMessage[−]

Performs the conversion.

impl Message for OwnedMessage[+]

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

Attempt to form a message from a series of data frames

pub fn message_size(&self, masked: bool) -> usize[−]

Returns how many bytes this message will take up

pub fn from_dataframes<D>(
    frames: Vec<D, Global>
) -> Result<OwnedMessage, WebSocketError> where
    D: DataFrame, [−]

Attempt to form a message from a series of data frames

impl PartialEq<OwnedMessage> for OwnedMessage[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &OwnedMessage) -> bool[−]

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

pub fn ne(&self, other: &OwnedMessage) -> bool[−]

This method tests for !=.

impl StructuralEq for OwnedMessage

impl StructuralPartialEq for OwnedMessage