Struct Broadcast

pub struct Broadcast<T>
where
    T: BroadcastTrait,
{ /* private fields */ }

Represents a broadcast mechanism for sending messages to multiple receivers.

This struct encapsulates the core components required for broadcasting, including the capacity of the broadcast channel and the sender responsible for dispatching messages.

Implementations

impl<T> Broadcast<T>

where T: BroadcastTrait,

Implements core functionalities for the Broadcast struct.

pub fn new(capacity: usize) -> Broadcast<T>

Creates a new Broadcast instance with a specified capacity.

Arguments

• Capacity - The maximum number of messages that can be buffered.

Returns

• Broadcast<T> - A new broadcast instance.

pub fn receiver_count(&self) -> usize

Retrieves the current number of active receivers subscribed to this broadcast channel.

Returns

• ReceiverCount - The total count of active receivers.

pub fn subscribe(&self) -> Receiver<T>

Subscribes a new receiver to the broadcast channel.

Returns

• BroadcastReceiver<T> - A new receiver instance.

pub fn send(&self, data: T) -> Result<usize, SendError<T>>

Sends a message to all active receivers subscribed to this broadcast channel.

Arguments

• T - The message to be broadcasted.

Returns

• BroadcastSendResult<T> - Result indicating send status.

Trait Implementations

impl<T> Clone for Broadcast<T>

where T: Clone + BroadcastTrait,

fn clone(&self) -> Broadcast<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Broadcast<T>

where T: Debug + BroadcastTrait,

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

Formats the value using the given formatter.

impl<T> Default for Broadcast<T>

where T: BroadcastTrait,

Provides a default implementation for Broadcast instances.

The default broadcast channel is initialized with a predefined sender capacity.

fn default() -> Broadcast<T>

Creates a new Broadcast instance with default settings.

Returns

• Broadcast<T> - A broadcast instance with default sender capacity.