Enum poem::web::websocket::Message

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

This is supported on crate feature websocket only.

An enum representing the various forms of a WebSocket message.

Variants

Text(String)

Tuple Fields

0: String

A text WebSocket message

Binary(Vec<u8>)

Tuple Fields

0: Vec<u8>

A binary WebSocket message

Ping(Vec<u8>)

Tuple Fields

0: Vec<u8>

A ping message with the specified payload

The payload here must have a length less than 125 bytes

Pong(Vec<u8>)

Tuple Fields

0: Vec<u8>

A pong message with the specified payload

The payload here must have a length less than 125 bytes

Close(Option<(CloseCode, String)>)

Tuple Fields

0: Option<(CloseCode, String)>

A close message with the optional close frame.

Implementations

impl Message

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

Construct a new text message.

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

Construct a new binary message.

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

Construct a new ping message.

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

Construct a new pong message.

pub fn close() -> Self

Construct the default close message.

pub fn close_with(code: impl Into<CloseCode>, reason: impl Into<String>) -> Self

Construct a close message with a code and reason.

pub fn is_text(&self) -> bool

Returns true if this message is a Text message.

pub fn is_binary(&self) -> bool

Returns true if this message is a Binary message.

pub fn is_ping(&self) -> bool

Returns true if this message is a Ping message.

pub fn is_pong(&self) -> bool

Returns true if this message is a Pong message.

pub fn is_close(&self) -> bool

Returns true if this message a is a Close message.

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

Destructure this message into binary data.

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

Return the bytes of this message, if the message can contain data.

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

This method tests for !=.

impl Sink<Message> for WebSocketStream

type Error = IoError

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