Struct Broadcaster

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

Sends values to a BroadcastChannel.

Implementations

impl<T> Broadcaster<T>

where T: Unpin + Clone + Send + 'static,

pub fn send(&self, value: T) -> Result<(), T>

Sends value to this channel.

If the channel is full, this function will block the current thread until space is made available. If one channel’s on_receive is sending a value to a bounded channel, that on_receive should be on_receive_async instead and use send_async().

Errors

Returns Err(value) if the channel is disconnected.

pub fn send_async(&self, value: T) -> BroadcastAsync<'_, T>

Sends value to this channel asynchronously.

If the channel is full, this future will wait until space is made available before sending.

Errors

The returned future will return Err(value) if the channel is disconnected.

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

Tries to send value to this channel. Returns an error if unable to send.

Errors

• When the channel is disconnected, TrySendError::Disconnected will be returned.
• When the channel is full, TrySendError::Full will be returned.

pub fn force_send(&self, value: T) -> Result<Option<T>, T>

Sends value to this channel, removing the oldest unread value if the channel is full.

If the channel is full, the unread value will be returned in Ok(Some(unread_value)). If the channel has capacity, Ok(None) will be returned.

Errors

Returns value if the channel is disconnected.

Trait Implementations

impl<T> Clone for Broadcaster<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: Debug> 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: Unpin + Clone + Send + 'static,

fn default() -> Self

Returns a disconnected broadcaster.

impl<T> Drop for Broadcaster<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<Broadcaster<T>> for Notify<T>

fn from(value: Broadcaster<T>) -> Self

Converts to this type from the input type.

impl<T> From<Broadcaster<T>> for SharedNotify<T>

fn from(value: Broadcaster<T>) -> Self

Converts to this type from the input type.