Struct BroadcastMap

pub struct BroadcastMap<T: BroadcastTrait>(/* private fields */);

Represents a concurrent, thread-safe map of broadcast channels, keyed by string.

This struct provides a way to manage multiple broadcast channels, each identified by a unique string, allowing for dynamic creation, retrieval, and management of broadcast streams.

Implementations

impl<T: BroadcastMapTrait> BroadcastMap<T>

Implements core functionalities for the BroadcastMap struct.

pub fn new() -> Self

Creates a new, empty BroadcastMap instance.

This is a convenience constructor that simply calls default().

Returns

• BroadcastMap<T> - An empty broadcast map.

pub fn insert<K>(&self, key: K, capacity: Capacity) -> OptionBroadcast<T>

where K: ToString,

Inserts a new broadcast channel into the map with a specified key and capacity.

If a broadcast channel with the given key already exists, it will be replaced.

Arguments

• K - Key convertible to String.
• Capacity - Maximum number of buffered messages.

Returns

• Option<Broadcast<T>> - Previous broadcast channel if replaced.

pub fn receiver_count<K>(&self, key: K) -> OptionReceiverCount

where K: ToString,

Retrieves the number of active receivers for the broadcast channel associated with the given key.

Arguments

• K - Key convertible to String.

Returns

• Option<ReceiverCount> - Number of receivers if channel exists.

pub fn subscribe<K>(&self, key: K) -> OptionBroadcastMapReceiver<T>

where K: ToString,

Subscribes a new receiver to the broadcast channel associated with the given key.

Arguments

• K - Key convertible to String.

Returns

• Option<BroadcastReceiver<T>> - New receiver if channel exists.

pub fn subscribe_or_insert<K>( &self, key: K, capacity: Capacity, ) -> BroadcastMapReceiver<T>

where K: ToString,

Subscribes a new receiver to the broadcast channel associated with the given key. If the channel does not exist, it will be created with the specified capacity before subscribing.

Arguments

• K - Key convertible to String.
• Capacity - Capacity for new channel if needed.

Returns

• BroadcastReceiver<T> - New receiver for the channel.

pub fn send<K>(&self, key: K, data: T) -> BroadcastMapSendResult<T>

where K: ToString,

Sends a message to the broadcast channel associated with the given key.

Arguments

• K - Key convertible to String.
• T - Message to broadcast.

Returns

• Result<Option<ReceiverCount>, SendError<T>> - Send result with receiver count or error.

Trait Implementations

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

fn clone(&self) -> BroadcastMap<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 BroadcastMap<T>

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

Formats the value using the given formatter.

impl<T: BroadcastMapTrait> Default for BroadcastMap<T>

Provides a default implementation for BroadcastMap instances.

The default broadcast map is initialized as an empty DashMap.

fn default() -> Self

Creates a new, empty BroadcastMap instance.

Returns

• BroadcastMap<T> - An empty broadcast map.