Enum Message

pub enum Message {
    Text(String),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close {
        code: CloseCode,
        reason: String,
    },
}

A WebSocket message, which can be a text string or binary data.

Variants

Text(String)

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.

WASM

This variant is ignored for WASM targets.

Pong(Bytes)

A pong message with the specified payload.

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

WASM

This variant is ignored for WASM targets.

Close

A close message.

Sending this will not close the connection. Use WebSocket::close for this. Though the remote peer will likely close the connection after receiving this.

Fields

code: CloseCode

reason: String

Implementations

impl Message

pub fn text_from_json<T: Serialize + ?Sized>(json: &T) -> Result<Self, Error>

Available on crate feature json only.

Tries to serialize the JSON as a Message::Text.

Optional

This requires the optional json feature enabled.

Errors

Serialization can fail if T’s implementation of Serialize decides to fail, or if T contains a map with non-string keys.

pub fn binary_from_json<T: Serialize + ?Sized>(json: &T) -> Result<Self, Error>

Available on crate feature json only.

Tries to serialize the JSON as a Message::Binary.

Optional

This requires that the optional json feature is enabled.

Errors

Serialization can fail if T’s implementation of Serialize decides to fail, or if T contains a map with non-string keys.

pub fn json<T: DeserializeOwned>(&self) -> Result<T, Error>

Available on crate feature json only.

Tries to deserialize the message body as JSON.

Optional

This requires that the optional json feature is enabled.

Errors

This method fails whenever the response body is not in JSON format, or it cannot be properly deserialized to target type T.

For more details please see serde_json::from_str and serde_json::from_slice.

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(value: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Message

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Message

fn from(value: Bytes) -> Self

Converts to this type from the input type.

impl From<Message> for Message

fn from(value: Message) -> Self

Converts to this type from the input type.

impl From<String> for Message

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Message

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

Converts to this type from the input type.

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

type Error = FromTungsteniteMessageError

The type returned in the event of a conversion error.

fn try_from(value: Message) -> Result<Self, Self::Error>

Performs the conversion.