Struct Broadcast 

pub struct Broadcast { /* private fields */ }

A broadcast channel for sending messages to multiple WebSocket clients

This is useful for implementing pub/sub patterns, chat rooms, or any scenario where you need to send the same message to multiple clients.

Example

use rustapi_ws::{Broadcast, Message};
use std::sync::Arc;

let broadcast = Arc::new(Broadcast::new());

// Subscribe to receive messages
let mut rx = broadcast.subscribe();

// Send a message to all subscribers
broadcast.send(Message::text("Hello everyone!"));

// Receive the message
let msg = rx.recv().await.unwrap();

Implementations

impl Broadcast

pub fn new() -> Self

Create a new broadcast channel with default capacity (100 messages)

pub fn with_capacity(capacity: usize) -> Self

Create a new broadcast channel with specified capacity

pub fn subscribe(&self) -> BroadcastReceiver

Subscribe to receive broadcast messages

pub fn send(&self, msg: Message) -> usize

Send a message to all subscribers

Returns the number of receivers that received the message. Returns 0 if there are no active subscribers.

pub fn send_text(&self, text: impl Into<String>) -> usize

Send a text message to all subscribers

pub fn send_json<T: Serialize>( &self, value: &T, ) -> Result<usize, WebSocketError>

Send a JSON message to all subscribers

pub fn subscriber_count(&self) -> usize

Get the current number of subscribers

pub fn has_subscribers(&self) -> bool

Check if there are any active subscribers

Trait Implementations

impl Clone for Broadcast

fn clone(&self) -> Broadcast

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Broadcast

fn default() -> Self

Returns the “default value” for a type.