Struct Message 

pub struct Message { /* private fields */ }

Available on crate feature websocket only.

A WebSocket message.

This will likely become a non-exhaustive enum in the future, once that language feature has stabilized.

Implementations

impl Message

pub fn text<S>(s: S) -> Message

where S: Into<Utf8Bytes>,

Construct a new Text Message.

pub fn binary<V>(v: V) -> Message

where V: Into<Bytes>,

Construct a new Binary Message.

pub fn ping<V>(v: V) -> Message

where V: Into<Bytes>,

Construct a new Ping Message.

pub fn pong<V>(v: V) -> Message

where V: Into<Bytes>,

Construct a new Pong Message.

pub fn close() -> Message

Construct the default Close Message.

pub fn close_with(code: impl Into<u16>, reason: impl Into<Utf8Bytes>) -> Message

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_close(&self) -> bool

Returns true if this message a is a Close 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 close_frame(&self) -> Option<(u16, &str)>

Try to get the close frame (close code and reason).

pub fn as_str(&self) -> Result<&str, Error>

Try to get a reference to the string text, if this is a Text message.

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

Returns the bytes of this message, if the message can contain 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<(), Error>

Formats the value using the given formatter.

impl Into<Vec<u8>> for Message

fn into(self) -> Vec<u8>

Converts this type into the (usually inferred) input type.

impl PartialEq for Message

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

Tests for self and other values to be equal, and is used by ==.

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

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 WebSocket>, cx: &mut Context<'_>, ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut WebSocket>, item: Message, ) -> Result<(), <WebSocket as Sink<Message>>::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 WebSocket>, cx: &mut Context<'_>, ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut WebSocket>, cx: &mut Context<'_>, ) -> Poll<Result<(), <WebSocket as Sink<Message>>::Error>>

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

impl Eq for Message

impl StructuralPartialEq for Message