[][src]Struct websocket_codec::Message

pub struct Message { /* fields omitted */ }

A text string, a block of binary data or a WebSocket control frame.


impl Message[src]

pub fn new<B: Into<Bytes>>(opcode: Opcode, data: B) -> Result<Self, Utf8Error>[src]

Creates a message from a Bytes object.

The message can be tagged as text or binary. When the opcode parameter is Opcode::Text this function validates the bytes in data and returns Err if they do not contain valid UTF-8 text.

pub fn text(data: &str) -> Self[src]

Creates a text message from a &str.

pub fn binary<B: Into<Bytes>>(data: B) -> Self[src]

Creates a binary message from any type that can be converted to Bytes, such as &[u8] or Vec<u8>.

pub fn close(reason: Option<(u16, &str)>) -> Self[src]

Creates a message that indicates the connection is about to be closed.

The reason parameter is an optional numerical status code and text description. Valid reasons may be defined by a particular WebSocket server.

pub fn ping<B: Into<Bytes>>(data: B) -> Self[src]

Creates a message requesting a pong response.

The client can send one of these to request a pong response from the server.

pub fn pong<B: Into<Bytes>>(data: B) -> Self[src]

Creates a response to a ping message.

The client can send one of these in response to a ping from the server.

pub fn opcode(&self) -> Opcode[src]

Returns this message's WebSocket opcode.

pub fn data(&self) -> &Bytes[src]

Returns a reference to the data held in this message.

pub fn into_data(self) -> Bytes[src]

Consumes the message, returning its data.

pub fn as_text(&self) -> Option<&str>[src]

For messages with opcode Opcode::Text, returns a reference to the text. Returns None otherwise.

Trait Implementations

impl Clone for Message[src]

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

Performs copy-assignment from source. Read more

impl PartialEq<Message> for Message[src]

impl Debug for Message[src]

Auto Trait Implementations

impl Send for Message

impl Sync for Message

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone

type Owned = T

impl<T, U> Into for T where
    U: From<T>, 

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> BorrowMut for T where
    T: ?Sized

impl<T, U> TryInto for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.