Struct SyncReceiver

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

The synchronous receiving half of a channel.

Implementations

impl<T> SyncReceiver<T>

pub fn into_async(self) -> Receiver<T>

Converts SyncReceiver to asynchronous Receiver.

pub fn recv(&self) -> Option<T>

Block waiting for a single value from the channel.

Returns None if all Senders are dropped.

pub fn recv_batch(&self, element_limit: usize) -> Vec<T>

Block waiting for 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(&self, element_limit: usize, vec: &mut Vec<T>)

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 SyncReceiver<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 SyncReceiver<T>

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

Formats the value using the given formatter.