Struct rweb::filters::ws::Message

pub struct Message { /* fields omitted */ }

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<String>, 

Construct a new Text Message.

pub fn binary<V>(v: V) -> Message where
    V: Into<Vec<u8, Global>>, 

Construct a new Binary Message.

pub fn ping<V>(v: V) -> Message where
    V: Into<Vec<u8, Global>>, 

Construct a new Ping Message.

pub fn close() -> Message

Construct the default Close Message.

pub fn close_with(
    code: impl Into<u16>,
    reason: impl Into<Cow<'static, str>>
) -> 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 to_str(&self) -> Result<&str, ()>

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

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

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

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

Destructure this message into binary data.

Trait Implementations

impl Clone for Message

pub fn clone(&self) -> Message

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Eq for Message

impl Into<Vec<u8, Global>> for Message

pub fn into(self) -> Vec<u8, Global>

Performs the conversion.

impl PartialEq<Message> for Message

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Sink<Message> for WebSocket

type Error = Error

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

pub 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.

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

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

Flush any remaining output from this sink.

pub 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 StructuralEq for Message

impl StructuralPartialEq for Message