Enum ClientMessage 

pub enum ClientMessage {
    Subscribe {
        channel: String,
        auth: Option<String>,
        channel_data: Option<Value>,
    },
    Unsubscribe {
        channel: String,
    },
    Whisper {
        channel: String,
        event: String,
        data: Value,
    },
    Ping,
}

A client-to-server message.

Variants

Subscribe

Subscribe to a channel.

Fields

channel: String

auth: Option<String>

channel_data: Option<Value>

Optional member data for presence channels (e.g. {"user_id": "42", "user_info": {"name": "Alice"}}).

Unsubscribe

Unsubscribe from a channel.

Fields

channel: String

Whisper

Send a message to a channel (client events).

Fields

channel: String

event: String

data: Value

Ping

Ping to keep connection alive.

Implementations

impl ClientMessage

pub fn from_ws_text(text: &str) -> Result<ClientMessage, Error>

Parse a client message from WebSocket text payload.

Trait Implementations

impl Clone for ClientMessage

fn clone(&self) -> ClientMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<ClientMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientMessage

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.