Receiver

Struct Receiver 

Source
pub struct Receiver<T, const N: usize> { /* private fields */ }
Expand description

The receiving half of a channel.

Receivers can be cloned to allow multiple consumers.

Implementations§

Source§

impl<T, const N: usize> Receiver<T, N>

Source

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

Receives a value from the channel.

§Errors

Returns Err(QueueEmpty) if no values are available.

Source

pub fn try_recv(&self) -> Result<T>

Attempts to receive a value without blocking.

Alias for recv.

§Errors

Returns Err(QueueEmpty) if no values are available.

Source

pub fn recv_spin(&self) -> T

Receives a value, spinning until one is available.

Source

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

Source

pub fn len(&self) -> usize

Returns the number of values in the channel.

Source

pub fn capacity(&self) -> usize

Returns the capacity of the channel.

Source

pub fn recv_batch(&self, buf: &mut [T], max: usize) -> usize

Source

pub fn recv_timeout(&self, timeout: Duration) -> Result<T>

Receives a value with a timeout.

Spins until a value is available or timeout is reached.

§Errors

Returns Err(QueueEmpty) if timeout is reached before a value is available.

Trait Implementations§

Source§

impl<T, const N: usize> Clone for Receiver<T, N>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Send, const N: usize> Send for Receiver<T, N>

Source§

impl<T: Send, const N: usize> Sync for Receiver<T, N>

Auto Trait Implementations§

§

impl<T, const N: usize> Freeze for Receiver<T, N>

§

impl<T, const N: usize> !RefUnwindSafe for Receiver<T, N>

§

impl<T, const N: usize> Unpin for Receiver<T, N>

§

impl<T, const N: usize> !UnwindSafe for Receiver<T, N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.