impl<T> UnboundedSender<T>

fn send(self: &Self, message: T) -> Result<(), SendError<T>>

Attempts to send a message on this UnboundedSender without blocking.

This method is not marked async because sending a message to an unbounded channel never requires any form of waiting. Because of this, the send method can be used in both synchronous and asynchronous code without problems.

If the receive half of the channel is closed, either due to close being called or the UnboundedReceiver having been dropped, this function returns an error. The error includes the value passed to send.

async fn closed(self: &Self)

Completes when the receiver has dropped.

This allows the producers to get notified when interest in the produced values is canceled and immediately stop doing work.

Cancel safety

This method is cancel safe. Once the channel is closed, it stays closed forever and all future calls to closed will return immediately.

Examples

use tokio::sync::mpsc;

#[tokio::main]
async fn main() {
    let (tx1, rx) = mpsc::unbounded_channel::<()>();
    let tx2 = tx1.clone();
    let tx3 = tx1.clone();
    let tx4 = tx1.clone();
    let tx5 = tx1.clone();
    tokio::spawn(async move {
        drop(rx);
    });

    futures::join!(
        tx1.closed(),
        tx2.closed(),
        tx3.closed(),
        tx4.closed(),
        tx5.closed()
    );
}

fn is_closed(self: &Self) -> bool

Checks if the channel has been closed. This happens when the UnboundedReceiver is dropped, or when the UnboundedReceiver::close method is called.

let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>();
assert!(!tx.is_closed());

let tx2 = tx.clone();
assert!(!tx2.is_closed());

drop(rx);
assert!(tx.is_closed());
assert!(tx2.is_closed());

fn same_channel(self: &Self, other: &Self) -> bool

Returns true if senders belong to the same channel.

Examples

let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>();
let  tx2 = tx.clone();
assert!(tx.same_channel(&tx2));

let (tx3, rx3) = tokio::sync::mpsc::unbounded_channel::<()>();
assert!(!tx3.same_channel(&tx2));

fn downgrade(self: &Self) -> WeakUnboundedSender<T>

Converts the UnboundedSender to a WeakUnboundedSender that does not count towards RAII semantics, i.e. if all UnboundedSender instances of the channel were dropped and only WeakUnboundedSender instances remain, the channel is closed.

fn strong_count(self: &Self) -> usize

Returns the number of UnboundedSender handles.

fn weak_count(self: &Self) -> usize

Returns the number of WeakUnboundedSender handles.

impl<T> Any for UnboundedSender<T>

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for UnboundedSender<T>

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for UnboundedSender<T>

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

impl<T> Clone for UnboundedSender<T>

fn clone(self: &Self) -> Self

impl<T> CloneToUninit for UnboundedSender<T>

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

impl<T> Debug for UnboundedSender<T>

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

impl<T> Freeze for UnboundedSender<T>

impl<T> From for UnboundedSender<T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> RefUnwindSafe for UnboundedSender<T>

impl<T> Send for UnboundedSender<T>

impl<T> Sync for UnboundedSender<T>

impl<T> ToOwned for UnboundedSender<T>

fn to_owned(self: &Self) -> T

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

impl<T> Unpin for UnboundedSender<T>

impl<T> UnsafeUnpin for UnboundedSender<T>

impl<T> UnwindSafe for UnboundedSender<T>

impl<T, U> Into for UnboundedSender<T>

fn into(self: 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 for UnboundedSender<T>

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

impl<T, U> TryInto for UnboundedSender<T>

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