Struct Sender 

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

Sends values to the associated Receiver.

Created by channel. Cloning it counts one more sender.

Implementations

impl<T> Sender<T>

pub async fn send(&self, value: T) -> Result<(), SendError<T>>

Sends a value, waiting in line for room if the channel is full.

Errors

A SendError holding the value when the receiver is closed or gone.

Cancel safety

A dropped future sent nothing and drops its value; it holds no slot.

use nuclei::sync::local::mpsc;

nuclei::runtime::block_on(async {
    let (tx, mut rx) = mpsc::channel(1);
    tx.send(1).await.unwrap();
    assert_eq!(rx.recv().await, Some(1));
});

pub fn try_send(&self, value: T) -> Result<(), TrySendError<T>>

Sends a value at once, or says why it cannot be sent. It never takes a slot ahead of a send or reservation that is waiting.

Errors

TrySendError::Full if no slot is free or a send is waiting, TrySendError::Closed if the receiver closed or was dropped. Both hold the value back.

pub async fn reserve(&self) -> Result<Permit<'_, T>, SendError<()>>

Waits in line for a slot and reserves it: the send through the Permit never waits and never fails.

Errors

A SendError when the receiver is closed or gone.

Cancel safety

A dropped future holds no slot.

pub fn try_reserve(&self) -> Result<Permit<'_, T>, TrySendError<()>>

Reserves a slot at once if one is free and nobody waits.

Errors

TrySendError::Full if no slot is free or a send is waiting, TrySendError::Closed if the receiver closed or was dropped.

pub async fn closed(&self)

Completes when the receiver has been closed or dropped. Cancel safe; once the channel is closed every call completes at once.

pub fn is_closed(&self) -> bool

Whether the receiver has been closed or dropped.

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

Whether both senders send to the same channel.

pub fn capacity(&self) -> usize

The channel’s current capacity: the slots that are free.

pub fn max_capacity(&self) -> usize

The channel’s maximum capacity: the buffer it was created with.

Trait Implementations

impl<T> Clone for Sender<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 Sender<T>

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

Formats the value using the given formatter.

impl<T> Drop for Sender<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.