Struct Broadcasting 

pub struct Broadcasting { /* private fields */ }

Publishes broadcasts through the configured driver.

What the Broadcast facade resolves to.

Implementations

impl Broadcasting

pub fn new(driver: Arc<dyn Broadcaster>) -> Broadcasting

Publishing through driver.

pub fn log() -> Broadcasting

Publishing to the log — the safe default, and what an unconfigured application gets.

pub fn driver_name(&self) -> &'static str

The driver’s name.

pub fn driver(&self) -> &Arc<dyn Broadcaster>

The driver, for the auth endpoint’s signature.

pub async fn event<E>(&self, event: &E) -> Result<(), Error>

where E: Broadcastable + ?Sized,

Publish an event.

Does nothing when the event says broadcast_when is false, or when it named no channels — both are answers, not errors.

pub async fn event_except<E>( &self, event: &E, socket_id: Option<String>, ) -> Result<(), Error>

where E: Broadcastable + ?Sized,

Publish an event to everyone except one socket.

The browser that caused the change has already applied it locally; echoing it back makes its own edit flicker. socket_id comes from the request’s X-Socket-ID header, and None means broadcast to all.

pub async fn to( &self, channels: Vec<Channel>, event: impl Into<String>, payload: Value, ) -> Result<(), Error>

Publish a payload directly, without an event type.

For something assembled at run time — a channel name computed from data, a payload proxied from elsewhere.

pub async fn send(&self, broadcast: Broadcast) -> Result<(), Error>

Publish an already-rendered broadcast.

Trait Implementations

impl Debug for Broadcasting

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

Formats the value using the given formatter.