Struct WeakUnboundedSender

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

An unbounded sender that does not prevent the channel from being closed.

If all UnboundedSender instances of a channel were dropped and only WeakUnboundedSender instances remain, the channel is closed.

In order to send messages, the WeakUnboundedSender needs to be upgraded using WeakUnboundedSender::upgrade, which returns Option<UnboundedSender>. It returns None if all UnboundedSenders have been dropped, and otherwise it returns an UnboundedSender.

Examples

use tokio::sync::mpsc::unbounded_channel;

# #[tokio::main(flavor = "current_thread")]
# async fn main() {
let (tx, _rx) = unbounded_channel::<i32>();
let tx_weak = tx.downgrade();

// Upgrading will succeed because `tx` still exists.
assert!(tx_weak.upgrade().is_some());

// If we drop `tx`, then it will fail.
drop(tx);
assert!(tx_weak.clone().upgrade().is_none());
# }

Implementations

impl<T> WeakUnboundedSender<T>

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

Tries to convert a WeakUnboundedSender into an UnboundedSender. This will return Some if there are other Sender instances alive and the channel wasn't previously dropped, otherwise None is returned.

fn strong_count(&self) -> usize

Returns the number of UnboundedSender handles.

fn weak_count(&self) -> usize

Returns the number of WeakUnboundedSender handles.

Trait Implementations

impl<T> Clone for WeakUnboundedSender<T>

fn clone(&self) -> Self

impl<T> Debug for WeakUnboundedSender<T>

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

impl<T> Drop for WeakUnboundedSender<T>

fn drop(&mut self)

Auto Trait Implementations

impl<T> Freeze for WeakUnboundedSender<T> where Arc<Chan<T, Semaphore>>: Freeze,

impl<T> RefUnwindSafe for WeakUnboundedSender<T> where Arc<Chan<T, Semaphore>>: RefUnwindSafe,

impl<T> Send for WeakUnboundedSender<T> where Arc<Chan<T, Semaphore>>: Send,

impl<T> Sync for WeakUnboundedSender<T> where Arc<Chan<T, Semaphore>>: Sync,

impl<T> Unpin for WeakUnboundedSender<T> where Arc<Chan<T, Semaphore>>: Unpin,

impl<T> UnsafeUnpin for WeakUnboundedSender<T> where Arc<Chan<T, Semaphore>>: UnsafeUnpin,

impl<T> UnwindSafe for WeakUnboundedSender<T> where Arc<Chan<T, Semaphore>>: UnwindSafe,

Blanket Implementations

impl<T> Any for WeakUnboundedSender<T> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for WeakUnboundedSender<T> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for WeakUnboundedSender<T> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for WeakUnboundedSender<T> where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for WeakUnboundedSender<T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for WeakUnboundedSender<T> where T: Clone,

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

impl<T, U> Into<U> for WeakUnboundedSender<T> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for WeakUnboundedSender<T> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for WeakUnboundedSender<T> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>