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, the values are returned in SendError untouched. Either the entire batch is sent or none of it is sent.

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.

TODO: add a feature that gates this only dependency on futures crate.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Drop for BoundedSender<T>

fn drop(&mut self)

Executes the destructor for this type.