Struct Broadcast

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

Re-exports constants, structs, traits, and types from the broadcast module. 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: BroadcastTrait> Broadcast<T>

Implements core functionalities for the Broadcast struct.

pub fn new(capacity: Capacity) -> Self

Creates a new Broadcast instance with a specified capacity.

Arguments

• capacity - The maximum number of messages that can be buffered in the broadcast channel.

Returns

A new Broadcast instance configured with the given capacity.

pub fn receiver_count(&self) -> ReceiverCount

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

Returns

The total count of active receivers.

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

Subscribes a new receiver to the broadcast channel.

Returns

A BroadcastReceiver that can be used to receive messages sent through this broadcast channel.

pub fn send(&self, data: T) -> BroadcastSendResult<T>

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

Arguments

• data - The message to be broadcasted.

Returns

A BroadcastSendResult indicating the number of receivers the message was sent to, or a BroadcastSendError if the send operation failed.

Trait Implementations

impl<T: Clone + BroadcastTrait> Clone for Broadcast<T>

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 + BroadcastTrait> Debug for Broadcast<T>

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

Formats the value using the given formatter.

impl<T: BroadcastTrait> Default for Broadcast<T>

Provides a default implementation for Broadcast instances.

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

fn default() -> Self

Creates a new Broadcast instance with default settings.

Returns

A Broadcast instance with a sender initialized to DEFAULT_BROADCAST_SENDER_CAPACITY and a capacity of 0.