Struct par_stream::BroadcastGuard

pub struct BroadcastGuard<T> { /* fields omitted */ }

The guard type returned from broadcast().

The guard is used to register new broadcast receivers, each consuming elements from the stream. The guard must be dropped, either by guard.finish() or drop(guard) before the receivers start consuming data. Otherwise, the receivers will receive panic.

Implementations

impl<T> BroadcastGuard<T> where
    T: 'static + Send, 

pub fn register(&mut self) -> BroadcastStream<T>

Creates a new receiver.

pub fn finish(self)

Drops the guard, so that created receivers can consume data without panic.

Trait Implementations

impl<T> Debug for BroadcastGuard<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Drop for BroadcastGuard<T>

fn drop(&mut self)

Executes the destructor for this type.