Enum WSMessage

pub enum WSMessage {
    Text(Utf8Bytes),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close(Option<CloseFrame>),
}

A WebSocket message.

Variants

Text(Utf8Bytes)

A text WebSocket message

Binary(Bytes)

A binary WebSocket message

Ping(Bytes)

A ping message with the specified payload

The payload here must have a length less than 125 bytes.

Ping messages will be automatically responded to by the server, so you do not have to worry about dealing with them yourself.

Pong(Bytes)

A pong message with the specified payload

The payload here must have a length less than 125 bytes.

Pong messages will be automatically sent to the client if a ping message is received, so you do not have to worry about constructing them yourself unless you want to implement a unidirectional heartbeat.

Close(Option<CloseFrame>)

A close message with the optional close frame.

You may “uncleanly” close a WebSocket connection at any time by simply dropping the WebSocket. However, you may also use the graceful closing protocol, in which

1. peer A sends a close frame, and does not send any further messages;
2. peer B responds with a close frame, and does not send any further messages;
3. peer A processes the remaining messages sent by peer B, before finally
4. both peers close the connection.

After sending a close frame, you may still read messages, but attempts to send another message will error. After receiving a close frame, axum will automatically respond with a close frame if necessary (you do not have to deal with this yourself). Since no further messages will be received, you may either do nothing or explicitly drop the connection.

Implementations

impl Message

pub fn into_data(self) -> Bytes

Consume the WebSocket and return it as binary data.

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

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

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

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

pub fn text<S>(string: S) -> Message

where S: Into<Utf8Bytes>,

Create a new text WebSocket message from a stringable.

pub fn binary<B>(bin: B) -> Message

where B: Into<Bytes>,

Create a new binary WebSocket message by converting to Bytes.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate 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<'b> From<&'b [u8]> for Message

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Bytes> for Message

fn from(data: Bytes) -> Message

Converts to this type from the input type.

impl From<String> for Message

fn from(string: String) -> Message

Converts to this type from the input type.

impl From<Vec<u8>> for Message

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

Converts to this type from the input type.

impl From<Message> for Vec<u8>

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

Converts to this type from the input type.

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 Sink<Message> for WebSocket

type Error = Error

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

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

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut WebSocket>, item: Message, ) -> Result<(), <WebSocket as Sink<Message>>::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 WebSocket>, cx: &mut Context<'_>, ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

Flush any remaining output from this sink.

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

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

impl Eq for Message

impl StructuralPartialEq for Message