Struct WeakUnboundedSender 

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

A sender that does not keep the channel open.

When every UnboundedSender is dropped and only WeakUnboundedSenders remain, the channel is closed for the receiver. upgrade turns it into an UnboundedSender while one exists.

use nuclei::sync::mpsc;

let (tx, _rx) = mpsc::unbounded_channel::<i32>();
let weak = tx.downgrade();
assert!(weak.upgrade().is_some());
drop(tx);
assert!(weak.clone().upgrade().is_none());

Progress

clone, drop, strong_count and weak_count are wait-free. upgrade is lock-free, not wait-free: it is a compare-and-swap on the sender count that retries when a sender was cloned or dropped meanwhile.

Implementations

impl<T> WeakUnboundedSender<T>

pub fn upgrade(&self) -> Option<UnboundedSender<T>>

Tries to turn the weak sender into an UnboundedSender.

Returns Some while at least one UnboundedSender is alive, and None once the last is gone.

pub fn strong_count(&self) -> usize

How many UnboundedSender handles exist.

pub fn weak_count(&self) -> usize

How many WeakUnboundedSender handles exist.

Trait Implementations

impl<T> Clone for WeakUnboundedSender<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for WeakUnboundedSender<T>

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

Formats the value using the given formatter.

impl<T> Drop for WeakUnboundedSender<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.