Struct tokio_websockets::proto::Message

pub struct Message { /* private fields */ }

A WebSocket message. This is cheaply clonable and uses Payload as the payload storage underneath.

Received messages are always validated prior to dealing with them, so all the type casting methods are either almost or fully zero cost.

Implementations

impl Message

pub fn text<P: Into<Payload>>(payload: P) -> Self

Create a new text message. The payload contents must be valid UTF-8.

pub fn binary<P: Into<Payload>>(payload: P) -> Self

Create a new binary message.

pub fn close(code: Option<CloseCode>, reason: &str) -> Self

Create a new close message. If an non-empty reason is specified, a CloseCode must be specified for it to be included.

pub fn ping<P: Into<Payload>>(payload: P) -> Self

Create a new ping message.

pub fn pong<P: Into<Payload>>(payload: P) -> Self

Create a new pong message.

pub fn is_text(&self) -> bool

Whether the message is a text message.

pub fn is_binary(&self) -> bool

Whether the message is a binary message.

pub fn is_close(&self) -> bool

Whether the message is a close message.

pub fn is_ping(&self) -> bool

Whether the message is a ping message.

pub fn is_pong(&self) -> bool

Whether the message is a pong message.

pub fn into_payload(self) -> Payload

Returns the message payload and consumes the message, regardless of type.

pub fn as_payload(&self) -> &Payload

Returns a reference to the message payload, regardless of message type.

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

Returns a reference to the message payload as a string if it is a text message.

Panics

This method will panic when the message was created via Message::text with invalid UTF-8.

pub fn as_close(&self) -> Option<(CloseCode, &str)>

Returns the CloseCode and close reason if the message is a close message.

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<T> Sink<Message> for WebSocketStream<T>

where T: AsyncRead + AsyncWrite + Unpin,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.