Struct BroadcastMap 

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

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> BroadcastMap<T>

where T: BroadcastMapTrait,

Implements core functionalities for the BroadcastMap struct.

pub fn new() -> BroadcastMap<T>

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: usize) -> Option<Broadcast<T>>

where K: AsRef<str>,

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

• AsRef<str> - Key convertible to str.
• capacity - Maximum number of buffered messages.

Returns

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

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

where K: AsRef<str>,

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

Arguments

• AsRef<str> - Key convertible to str.

Returns

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

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

where K: AsRef<str>,

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

Arguments

• AsRef<str> - Key convertible to str.

Returns

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

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

where K: AsRef<str>,

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

• AsRef<str> - Key convertible to str.
• capacity - Capacity for new channel if needed.

Returns

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

pub fn try_send<K>( &self, key: K, data: T, ) -> Result<Option<usize>, SendError<T>>

where K: AsRef<str>,

Attempts to send a message to the broadcast channel associated with the given key.

Arguments

• AsRef<str> - Key convertible to str.
• T - Message to broadcast.

Returns

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

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

where K: AsRef<str>,

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

Arguments

• AsRef<str> - Key convertible to str.
• T - Message to broadcast.

Returns

• Option<ReceiverCount> - The receiver count if the channel exists.

Panics

Panics if the send operation fails (e.g., if the channel is closed).

pub fn unsubscribe<K>(&self, key: K) -> Option<Broadcast<T>>

where K: AsRef<str>,

Unsubscribes and removes the broadcast channel associated with the given key from the map.

This operation effectively cancels all subscriptions to the channel by removing it from the map. Any existing receivers will no longer receive new messages, and the channel will be dropped.

Arguments

• AsRef<str> - Key convertible to str.

Returns

• Option<Broadcast<T>> - The removed broadcast channel if it existed, or None if no channel was associated with the key.

Trait Implementations

impl<T> Clone for BroadcastMap<T>

where T: Clone + BroadcastTrait,

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 for BroadcastMap<T>

where T: Debug + BroadcastTrait,

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

Formats the value using the given formatter.

impl<T> Default for BroadcastMap<T>

where T: BroadcastMapTrait,

Provides a default implementation for BroadcastMap instances.

The default broadcast map is initialized as an empty DashMap.

fn default() -> BroadcastMap<T>

Creates a new, empty BroadcastMap instance.

Returns

• BroadcastMap<T> - An empty broadcast map.