Struct Message

pub struct Message { /* private fields */ }

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

Implementations

impl Message

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

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<S: Into<String>>(data: S) -> Self

Creates a text message from a String.

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

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, String)>) -> Self

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

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

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

Returns this message’s WebSocket opcode.

pub fn data(&self) -> &Bytes

Returns a reference to the data held in this message.

pub fn into_data(self) -> Bytes

Consumes the message, returning its data.

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

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

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

Formats the value using the given formatter.

impl<'a> Encoder<&'a Message> for MessageCodec

type Error = Box<dyn Error + Send + Sync>

The type of encoding errors.

fn encode(&mut self, item: &Message, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.

impl Encoder<Message> for MessageCodec

type Error = Box<dyn Error + Send + Sync>

The type of encoding errors.

fn encode(&mut self, item: Message, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.

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 StructuralPartialEq for Message