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

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]
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§

source§

impl<T> WeakUnboundedSender<T>

source

pub 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.

Trait Implementations§

source§

impl<T> Clone for WeakUnboundedSender<T>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for WeakUnboundedSender<T>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for WeakUnboundedSender<T>

§

impl<T> Send for WeakUnboundedSender<T>where T: Send,

§

impl<T> Sync for WeakUnboundedSender<T>where T: Send,

§

impl<T> Unpin for WeakUnboundedSender<T>

§

impl<T> !UnwindSafe for WeakUnboundedSender<T>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.