Enum axum::extract::ws::Message

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

Available on crate feature ws only.

A WebSocket message.

Variants

Text(String)

A text WebSocket message

Binary(Vec<u8>)

A binary WebSocket message

Ping(Vec<u8>)

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

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<'static>>)

A close message with the optional close frame.

Implementations

impl Message

pub fn into_data(self) -> Vec<u8>

Consume the WebSocket and return it as binary data.

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

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

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.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Message> for Vec<u8>

fn from(msg: Message) -> Self

Converts to this type from the input type.

impl From<String> for Message

fn from(string: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for Message

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

Converts to this type from the input type.

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: &Rhs) -> bool

This method 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 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.

impl Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message