Enum WebSocketMessage 

pub enum WebSocketMessage {
    Text(ByteStr),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close,
}

Message transmitted over a websocket connection.

Variants

Text(ByteStr)

UTF-8 text payload.

Binary(Bytes)

Binary payload.

Ping(Bytes)

Ping control frame.

Pong(Bytes)

Pong control frame.

Close

Close control frame.

Implementations

impl WebSocketMessage

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

Construct a text message.

pub fn ping(value: impl Into<Bytes>) -> Self

Construct a ping message.

pub fn pong(value: impl Into<Bytes>) -> Self

Construct a pong message.

pub fn close() -> Self

Construct a close message.

pub fn binary(value: impl Into<Bytes>) -> Self

Construct a binary message.

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

Construct a JSON message.

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

Returns the payload as text when possible.

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

Returns the payload as raw bytes when possible.

pub fn into_text(self) -> Option<ByteStr>

Converts the payload into owned text when possible.

pub fn into_json<T>(self) -> Option<Result<T, Error>>

where T: DeserializeOwned,

Converts the payload into a JSON value when possible.

pub fn into_bytes(self) -> Option<Bytes>

Converts the payload into owned bytes when possible.

Trait Implementations

impl Clone for WebSocketMessage

fn clone(&self) -> WebSocketMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketMessage

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

Formats the value using the given formatter.

impl Eq for WebSocketMessage

impl From<&[u8]> for WebSocketMessage

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for WebSocketMessage

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<ByteStr> for WebSocketMessage

fn from(value: ByteStr) -> Self

Converts to this type from the input type.

impl From<Bytes> for WebSocketMessage

fn from(value: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for WebSocketMessage

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for WebSocketMessage

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

Converts to this type from the input type.

impl PartialEq for WebSocketMessage

fn eq(&self, other: &WebSocketMessage) -> 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 StructuralPartialEq for WebSocketMessage