Struct batch_channel::Receiver

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

The receiving half of a channel.

Implementations

impl<T> Receiver<T>

pub fn recv(&self) -> impl Future<Output = Option<T>> + '_

Wait for a single value from the channel.

Returns None if all Senders are dropped.

pub fn recv_batch( &self, element_limit: usize ) -> impl Future<Output = Vec<T>> + '_

Wait for up to element_limit values from the channel.

Up to element_limit values are returned if they’re already available. Otherwise, waits for any values to be available.

Returns an empty Vec if all Senders are dropped.

pub fn recv_vec<'a>( &'a self, element_limit: usize, vec: &'a mut Vec<T> ) -> impl Future<Output = ()> + 'a

Wait for up to element_limit values from the channel and store them in vec.

vec should be empty when passed in. Nevertheless, recv_vec will clear it before adding values. The intent of recv_vec is that batches can be repeatedly read by workers without new allocations.

It’s not required, but vec’s capacity should be greater than or equal to element_limit to avoid reallocation.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.