Struct Broadcaster 

pub struct Broadcaster<T> { /* private fields */ }

A bounded, cancellable fan-out broadcaster.

Cheaply cloneable; every clone shares the same subscriber set, so an event broadcast through any clone reaches all live subscribers. T must be Clone (each subscriber receives its own copy) and Send + 'static to cross the per-subscriber channel.

Implementations

impl<T> Broadcaster<T>

where T: Clone + Send + 'static,

pub fn new() -> Self

Create a broadcaster with the DEFAULT_BROADCAST_BUFFER per-subscriber buffer.

pub fn with_buffer(buffer: usize) -> Self

Create a broadcaster with an explicit per-subscriber buffer.

A buffer of zero is clamped to one so every subscriber can hold at least one in-flight event.

impl<T> Broadcaster<T>

pub const fn buffer(&self) -> usize

The per-subscriber buffer capacity.

pub fn subscriber_count(&self) -> usize

The number of currently registered subscribers.

Disconnected subscribers are pruned lazily on broadcast, so this count may transiently include subscribers whose streams have been dropped but not yet pruned.

pub fn subscribe(&self, cancel: CancellationToken) -> BroadcastStream<T>

where T: Send + 'static,

Register a new subscriber and return its bounded, cancellable stream.

The returned stream yields events broadcast after subscription and terminates once cancel fires or the broadcaster is dropped. Pass a fresh CancellationToken when no external cancellation is required.

pub fn broadcast(&self, item: &T)

where T: Clone,

Fan item out to every live subscriber.

Each subscriber receives an independent clone. A subscriber whose buffer is full is retained but skips this event (bounded drop backpressure); a subscriber whose stream has been dropped is pruned.

Trait Implementations

impl<T> Clone for Broadcaster<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Broadcaster<T>

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

Formats the value using the given formatter.

impl<T> Default for Broadcaster<T>

where T: Clone + Send + 'static,

fn default() -> Self

Returns the “default value” for a type.