Enum Message 

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

An enum representing the various forms of 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

Pong(Bytes)

A pong message with the specified payload

The payload here must have a length less than 125 bytes

Close(Option<CloseFrame>)

A close message with the optional close frame.

Frame(Frame)

Raw frame. Note, that you’re not going to get this value while reading the message.

Implementations

impl Message

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

where S: Into<Utf8Bytes>,

Create a new text WebSocket message from a stringable.

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

where B: Into<Bytes>,

Create a new binary WebSocket message by converting to Bytes.

pub fn is_text(&self) -> bool

Indicates whether a message is a text message.

pub fn is_binary(&self) -> bool

Indicates whether a message is a binary message.

pub fn is_ping(&self) -> bool

Indicates whether a message is a ping message.

pub fn is_pong(&self) -> bool

Indicates whether a message is a pong message.

pub fn is_close(&self) -> bool

Indicates whether a message is a close message.

pub fn len(&self) -> usize

Get the length of the WebSocket message.

pub fn is_empty(&self) -> bool

Returns true if the WebSocket message has no content. For example, if the other side of the connection sent an empty string.

pub fn into_data(self) -> Bytes

Consume the WebSocket message and return it as binary data.

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

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

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

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

fn fmt(&self, f: &mut Formatter<'_>) -> StdResult<(), Error>

Formats the value using the given formatter.

impl Eq for Message

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

fn from(data: Bytes) -> Self

Converts to this type from the input type.

impl From<Message> for Bytes

fn from(message: 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>> for Message

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

Converts to this type from the input type.

impl From<WebSocketRelayMessage> for Message

fn from(value: WebSocketRelayMessage) -> Self

Converts to this type from the input type.

impl PartialEq for Message

fn eq(&self, other: &Message) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<S> Sink<Message> for ClientWebSocket<S>

where S: Sink<Message, Error = ProtocolError> + Unpin,

type Error = ProtocolError

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, message: 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>, ctx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

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

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

impl<S> Sink<Message> for ServerWebSocket<S>

where S: Sink<Message, Error = ProtocolError> + Unpin,

type Error = ProtocolError

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, message: 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>, ctx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

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

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

impl<S> Sink<Message> for HARWebSocket<S>

where S: Sink<Message, Error = ProtocolError> + Unpin,

type Error = ProtocolError

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

fn poll_ready( self: Pin<&mut Self>, ctx: &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>, ctx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

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

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

impl<T> Sink<Message> for AsyncWebSocket<T>

where T: Io + Unpin,

type Error = ProtocolError

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