Struct async_broadcast::InactiveReceiver

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

An inactive receiver.

An inactive receiver is a receiver that is unable to receive messages. It’s only useful for keeping a channel open even when no associated active receivers exist.

Implementations

impl<T> InactiveReceiver<T>

pub fn activate(self) -> Receiver<T>

Convert to an activate Receiver.

Consumes self. Use InactiveReceiver::activate_cloned if you want to keep self.

Examples

use async_broadcast::{broadcast, TrySendError};

let (s, r) = broadcast(1);
let inactive = r.deactivate();
assert_eq!(s.try_broadcast(10), Err(TrySendError::Inactive(10)));

let mut r = inactive.activate();
assert_eq!(s.try_broadcast(10), Ok(None));
assert_eq!(r.try_recv(), Ok(10));

pub fn activate_cloned(&self) -> Receiver<T>

Create an activate Receiver for the associated channel.

Examples

use async_broadcast::{broadcast, TrySendError};

let (s, r) = broadcast(1);
let inactive = r.deactivate();
assert_eq!(s.try_broadcast(10), Err(TrySendError::Inactive(10)));

let mut r = inactive.activate_cloned();
assert_eq!(s.try_broadcast(10), Ok(None));
assert_eq!(r.try_recv(), Ok(10));

Trait Implementations

impl<T: Clone> Clone for InactiveReceiver<T>

fn clone(&self) -> InactiveReceiver<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for InactiveReceiver<T>

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

Formats the value using the given formatter.

impl<T> Drop for InactiveReceiver<T>

fn drop(&mut self)

Executes the destructor for this type.