Struct Sender

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

The asynchronous sending half of a channel.

Implementations

impl<T> Sender<T>

pub fn into_sync(self) -> SyncSender<T>

Converts asynchronous Sender to SyncSender.

pub fn send( &self, value: T, ) -> impl Future<Output = Result<(), SendError<T>>> + '_

Send a single value.

Returns SendError if all receivers are dropped.

pub fn send_iter<'a, I>( &'a self, values: I, ) -> impl Future<Output = Result<(), SendError<()>>> + 'a

where I: IntoIterator<Item = T> + 'a,

Send multiple values.

If all receivers are dropped, SendError is returned and unsent values are dropped.

pub async fn autobatch<F, R>( self, batch_limit: usize, f: F, ) -> Result<R, SendError<()>>

where for<'a> F: FnOnce(&'a mut BatchSender<T>) -> BoxFuture<'a, Result<R, SendError<()>>>,

Automatically accumulate sends into a buffer of size batch_limit and send when full.

The callback’s future must be boxed to work around type system limitations in Rust.

There is a git branch that shows what an API based on async closures would look like.

pub async fn autobatch_or_cancel<F>(self, capacity: usize, f: F)

where for<'a> F: FnOnce(&'a mut BatchSender<T>) -> BoxFuture<'a, Result<(), SendError<()>>>,

Same as Sender::autobatch except that it immediately returns () when f returns SendError. This is a convenience wrapper for the common case that the future is passed to a spawn function and the receiver being dropped (i.e. SendError) is considered a clean cancellation.

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Sender<T>

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

Formats the value using the given formatter.