Struct routerify_websocket::Message

pub struct Message { /* fields omitted */ }

A WebSocket message.

Implementations

impl Message

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

Create a new Text WebSocket message from a stringable.

pub fn json<T: Serialize>(value: &T) -> Result<Message>

Constructs a Text WebSocket message with the json value.

Optional

This requires the optional json feature to be enabled.

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

Create a new Binary WebSocket message.

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

Construct a new Ping WebSocket message.

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

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

Construct a new Pong WebSocket message.

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

pub fn close() -> Message

Construct the default Close WebSocket message.

pub fn close_with<R: Into<Cow<'static, str>>>(
    code: CloseCode,
    reason: R
) -> Message

Construct a Close WebSocket 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 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 close_code(&self) -> Option<CloseCode>

The Close code if available.

pub fn close_reason(&self) -> Option<&str>

The Close reason if available.

pub fn as_text(&self) -> Result<&str>

Attempts to convert the message data as text in UTF8 format.

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

Return the bytes of this message.

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

Consumes the message and returns its data as bytes.

pub fn into_text(self) -> Result<String>

Consumes the WebSocket message and attempts to converts it to a String.

pub fn decode_json<T: DeserializeOwned>(self) -> Result<T>

Try to deserialize the message data as JSON.

Optional

This requires the optional json feature to be enabled.

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 Into<Vec<u8, Global>> for Message

fn into(self) -> Vec<u8>

Performs the conversion.

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 WebSocket

type Error = WebsocketError

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