Struct broadcaster::BroadcastChannel

pub struct BroadcastChannel<T, S = UnboundedSender<T>, R = UnboundedReceiver<T>> where
    T: Send + Clone + 'static,
    S: Send + Sync + Unpin + Clone + Sink<T>,
    R: Unpin + Stream<Item = T>,  { /* fields omitted */ }

A broadcast channel, wrapping any clonable Stream and Sink to have every message sent to every receiver.

Methods

impl<T: Send + Clone> BroadcastChannel<T>

pub fn new() -> Self

Create a new unbounded channel. Requires the default-channels feature.

impl<T: Send + Clone> BroadcastChannel<T, Sender<T>, Receiver<T>>

pub fn with_cap(cap: usize) -> Self

Create a new bounded channel with a specific capacity. Requires the default-channels feature.

pub fn try_send(&self, item: &T) -> Result<(), TrySendError<T>>

Try sending a value on a bounded channel. Requires the default-channels feature.

impl<T, S, R> BroadcastChannel<T, S, R> where
    T: Send + Clone + 'static,
    S: Send + Sync + Unpin + Clone + Sink<T>,
    R: Unpin + Stream<Item = T>, 

pub fn with_ctor(ctor: Arc<dyn Fn() -> (S, R) + Send + Sync>) -> Self

Construct a new channel from any Sink and Stream. For proper functionality, cloning a Sender will create a new sink that also sends data to Receiver.

pub async fn send<'_, '_>(&'_ self, item: &'_ T) -> Result<(), S::Error>

Send an item to all receivers in the channel, including this one. This is because futures-channel does not support comparing a sender and receiver. If this is not the desired behavior, you must handle it yourself.

pub fn recv(&mut self) -> impl Future<Output = Option<T>> + '_

Receive a single value from the channel.

Trait Implementations

impl<T, S, R> Drop for BroadcastChannel<T, S, R> where
    T: Send + Clone + 'static,
    S: Send + Sync + Unpin + Clone + Sink<T>,
    R: Unpin + Stream<Item = T>, 

fn drop(&mut self)

Executes the destructor for this type.

impl<T, S, R> Clone for BroadcastChannel<T, S, R> where
    T: Send + Clone + 'static,
    S: Send + Sync + Unpin + Clone + Sink<T>,
    R: Unpin + Stream<Item = T>, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S, R> Debug for BroadcastChannel<T, S, R> where
    T: Send + Clone + 'static,
    S: Send + Sync + Unpin + Clone + Debug + Sink<T>,
    R: Unpin + Debug + Stream<Item = T>, 

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

Formats the value using the given formatter.