Struct BroadcastChannel 

pub struct BroadcastChannel { /* private fields */ }

A handle to a named broadcast channel.

Obtain one via [Broadcasting::channel], [Broadcasting::private_channel], or [Broadcasting::presence_channel].

Implementations

impl BroadcastChannel

pub fn new( name: String, kind: ChannelKind, driver: Arc<dyn BroadcastDriver>, ) -> Self

pub fn to_user(self, user_id: impl ToString) -> Self

Scope the emission to a specific user’s channel ({name}.{user_id}).

pub async fn emit<T: Serialize>( &self, event: impl Into<String>, data: &T, ) -> Result<(), BroadcastError>

Emit an event with a serializable payload.

pub async fn emit_raw( &self, event: impl Into<String>, data: Value, ) -> Result<(), BroadcastError>

Emit a raw JSON value.

pub fn kind(&self) -> ChannelKind

pub fn name(&self) -> &str