Struct batch_channel::BoundedSender

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

The sending half of a bounded channel.

Implementations

impl<T: 'static> BoundedSender<T>

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<()>>> + 'awhere 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, capacity: usize, f: F ) -> Result<R, SendError<()>>where for<'a> F: FnOnce(&'a mut BoundedBatchSender<T>) -> BoxFuture<'a, Result<R, SendError<()>>>,

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

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

pub async fn autobatch_or_cancel<F>(self, capacity: usize, f: F)where for<'a> F: FnOnce(&'a mut BoundedBatchSender<T>) -> BoxFuture<'a, Result<(), SendError<()>>>,

Same as [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 BoundedSender<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BoundedSender<T>

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

Formats the value using the given formatter.