Struct Receiver

pub struct Receiver<'ch, M, T, const N: usize>
where
    M: RawMutex,
{ /* private fields */ }

Receive-only access to a Channel.

Implementations

impl<'ch, M, T, const N: usize> Receiver<'ch, M, T, N>

where M: RawMutex,

pub fn receive(&self) -> ReceiveFuture<'_, M, T, N>

Receive the next value.

See Channel::receive().

pub fn ready_to_receive(&self) -> ReceiveReadyFuture<'_, M, T, N>

Is a value ready to be received in the channel

See Channel::ready_to_receive().

pub fn try_receive(&self) -> Result<T, TryReceiveError>

Attempt to immediately receive the next value.

See Channel::try_receive()

pub fn try_peek(&self) -> Result<T, TryReceiveError>

where T: Clone,

Peek at the next value without removing it from the queue.

See Channel::try_peek()

pub fn poll_ready_to_receive(&self, cx: &mut Context<'_>) -> Poll<()>

Allows a poll_fn to poll until the channel is ready to receive

See Channel::poll_ready_to_receive()

pub fn poll_receive(&self, cx: &mut Context<'_>) -> Poll<T>

Poll the channel for the next item

See Channel::poll_receive()

pub const fn capacity(&self) -> usize

Returns the maximum number of elements the channel can hold.

See Channel::capacity()

pub fn free_capacity(&self) -> usize

Returns the free capacity of the channel.

See Channel::free_capacity()

pub fn clear(&self)

Clears all elements in the channel.

See Channel::clear()

pub fn len(&self) -> usize

Returns the number of elements currently in the channel.

See Channel::len()

pub fn is_empty(&self) -> bool

Returns whether the channel is empty.

See Channel::is_empty()

pub fn is_full(&self) -> bool

Returns whether the channel is full.

See Channel::is_full()

Trait Implementations

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

where M: RawMutex,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'ch, M, T: Debug, const N: usize> Debug for Receiver<'ch, M, T, N>

where M: RawMutex + Debug,

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

Formats the value using the given formatter.

impl<'ch, M, T, const N: usize> From<Receiver<'ch, M, T, N>> for DynamicReceiver<'ch, T>

where M: RawMutex,

fn from(s: Receiver<'ch, M, T, N>) -> Self

Converts to this type from the input type.

impl<'ch, M, T, const N: usize> From<Receiver<'ch, M, T, N>> for SendDynamicReceiver<'ch, T>

where M: RawMutex + Sync + Send,

fn from(s: Receiver<'ch, M, T, N>) -> Self

Converts to this type from the input type.

impl<'ch, M, T, const N: usize> Stream for Receiver<'ch, M, T, N>

where M: RawMutex,

type Item = T

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'ch, M, T, const N: usize> Copy for Receiver<'ch, M, T, N>

where M: RawMutex,