Enum roa::websocket::Message

pub enum Message {
    Text(String),
    Binary(Vec<u8>),
    Ping(Vec<u8>),
    Pong(Vec<u8>),
    Close(Option<CloseFrame<'static>>),
}

This is supported on feature="websocket" only.

An enum representing the various forms of a WebSocket message.

Variants

Text(String)

This is supported on feature="websocket" only.

A text WebSocket message

Binary(Vec<u8>)

This is supported on feature="websocket" only.

A binary WebSocket message

Ping(Vec<u8>)

This is supported on feature="websocket" only.

A ping message with the specified payload

The payload here must have a length less than 125 bytes

Pong(Vec<u8>)

This is supported on feature="websocket" only.

A pong message with the specified payload

The payload here must have a length less than 125 bytes

Close(Option<CloseFrame<'static>>)

This is supported on feature="websocket" only.

A close message with the optional close frame.

Methods

impl Message

pub fn text<S>(string: S) -> Message where
    S: Into<String>, 

This is supported on feature="websocket" only.

Create a new text WebSocket message from a stringable.

pub fn binary<B>(bin: B) -> Message where
    B: Into<Vec<u8>>, 

This is supported on feature="websocket" only.

Create a new binary WebSocket message by converting to Vec.

pub fn is_text(&self) -> bool

This is supported on feature="websocket" only.

Indicates whether a message is a text message.

pub fn is_binary(&self) -> bool

This is supported on feature="websocket" only.

Indicates whether a message is a binary message.

pub fn is_ping(&self) -> bool

This is supported on feature="websocket" only.

Indicates whether a message is a ping message.

pub fn is_pong(&self) -> bool

This is supported on feature="websocket" only.

Indicates whether a message is a pong message.

pub fn is_close(&self) -> bool

This is supported on feature="websocket" only.

Indicates whether a message ia s close message.

pub fn len(&self) -> usize

This is supported on feature="websocket" only.

Get the length of the WebSocket message.

pub fn is_empty(&self) -> bool

This is supported on feature="websocket" only.

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) -> Vec<u8>

This is supported on feature="websocket" only.

Consume the WebSocket and return it as binary data.

pub fn into_text(self) -> Result<String, Error>

This is supported on feature="websocket" only.

Attempt to consume the WebSocket message and convert it to a String.

pub fn to_text(&self) -> Result<&str, Error>

This is supported on feature="websocket" only.

Attempt to get a &str from the WebSocket message, this will try to convert binary data to utf8.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Display for Message

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

Formats the value using the given formatter.

impl Eq for Message

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

fn from(data: &'b [u8]) -> Message

Performs the conversion.

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

fn from(string: &'s str) -> Message

Performs the conversion.

impl From<String> for Message

fn from(string: String) -> Message

Performs the conversion.

impl From<Vec<u8>> for Message

fn from(data: Vec<u8>) -> Message

Performs the conversion.

impl Into<Vec<u8>> for Message

fn into(self) -> Vec<u8>

Performs the conversion.

impl PartialEq<Message> for Message

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

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

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

This method tests for !=.

impl StructuralEq for Message

impl StructuralPartialEq for Message