Struct BroadcastMessage 

pub struct BroadcastMessage {
    pub event: String,
    pub channel: String,
    pub data: Value,
}

A message that can be broadcast to channels.

Fields

event: String

The event name.

channel: String

The channel name.

data: Value

The message data.

Implementations

impl BroadcastMessage

pub fn new( channel: impl Into<String>, event: impl Into<String>, data: impl Serialize, ) -> BroadcastMessage

Create a new broadcast message.

pub fn with_data( channel: impl Into<String>, event: impl Into<String>, data: Value, ) -> BroadcastMessage

Create with raw JSON data.

pub fn to_json(&self) -> Result<String, Error>

Serialize to JSON string.

pub fn to_ws_message(&self) -> Result<Message, Error>

Convert to a WebSocket text message.

Trait Implementations

impl Clone for BroadcastMessage

fn clone(&self) -> BroadcastMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BroadcastMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BroadcastMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BroadcastMessage

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.