Enum Message 

pub enum Message {
    Text(Bytes),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close(Option<CloseReason>),
}

WebSocket message (complete, possibly assembled from fragments)

Text messages use Bytes internally for zero-copy efficiency. The payload is UTF-8 validated during parsing, so as_text() is safe.

Variants

Text(Bytes)

Text message (UTF-8 validated, stored as Bytes for zero-copy)

Binary(Bytes)

Binary message

Ping(Bytes)

Ping message

Pong(Bytes)

Pong message

Close(Option<CloseReason>)

Close message

Implementations

impl Message

pub fn text(s: impl Into<String>) -> Self

Create a text message from a string

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

Create a binary message

pub fn ping(data: impl Into<Bytes>) -> Self

Create a ping message

pub fn pong(data: impl Into<Bytes>) -> Self

Create a pong message

pub fn is_close(&self) -> bool

Check if this is a close message

pub fn is_text(&self) -> bool

Check if this is a text message

pub fn is_binary(&self) -> bool

Check if this is a binary message

pub fn is_ping(&self) -> bool

Check if this is a ping message

pub fn is_pong(&self) -> bool

Check if this is a pong message

pub fn is_control(&self) -> bool

Check if this is a control message

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

Get message as text (returns None for non-text messages)

This is zero-copy - it returns a reference to the underlying bytes. The text is guaranteed to be valid UTF-8 as it was validated during parsing.

pub fn as_bytes(&self) -> &[u8]

Get message as bytes

pub fn into_text(self) -> Option<String>

Convert to text message (allocates a String)

Returns None for non-text messages.

pub fn text_bytes(&self) -> Option<&Bytes>

Get the underlying Bytes for text messages (zero-copy)

Returns None for non-text messages.

pub fn into_bytes(self) -> Bytes

Convert to binary data

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

Formats the value using the given formatter.

impl From<&[u8]> for Message

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

Converts to this type from the input type.

impl From<&str> for Message

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Message

fn from(b: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for Message

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Message

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

Converts to this type from the input type.

impl<S> Sink<Message> for CompressedWebSocketStream<S>

where S: AsyncRead + AsyncWrite + Unpin,

Available on crate feature permessage-deflate only.

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

Attempts to prepare the Sink to receive a value.

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

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

Flush any remaining output from this sink.

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

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

impl<S> Sink<Message> for WebSocketStream<S>

where S: 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<()>>

Attempts to prepare the Sink to receive a value.

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

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

Flush any remaining output from this sink.

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

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