Struct runa_core::events::broadcast::Broadcast

pub struct Broadcast<E>(_, _);

An event source implementation based on the [async_broadcast] channels.

This event source is mpmc, so it can be cloned, enabling multiple sender to send at the same time

Implementations

impl<E: Clone> Broadcast<E>

pub fn broadcast(&self, msg: E) -> impl Future<Output = ()> + '_

Send a new event to all receivers

pub fn broadcast_owned(&self, msg: E) -> BroadcastOwned<E>where E: 'static,

Like Self::broadcast, but the returned future doesn’t borrow from self.

pub fn broadcast_reserve(&mut self, msg: E)

Like Self::broadcast, but if the queue is full, instead of waiting, this function will allocate more space in the queue.

Warning

If there are stuck receivers, this will cause unbounded memory growth.

Trait Implementations

impl<E> Clone for Broadcast<E>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Broadcast<E>

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

Formats the value using the given formatter.

impl<E> Default for Broadcast<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Clone + 'static> EventSource<E> for Broadcast<E>

type Source = Receiver<E>

Type of event stream you get from this event source.

fn subscribe(&self) -> Self::Source

Get a stream of events from the event source.