embassy-sync

Crates

git

Versions

default

Flavors

embassy_sync::priority_channel

Struct Receiver

Source
pub struct Receiver<'ch, M, T, K, const N: usize>
where T: Ord, K: Kind, M: RawMutex,
{ /* private fields */ }
Expand description

Receive-only access to a PriorityChannel.

Implementations§

Source§

impl<'ch, M, T, K, const N: usize> Receiver<'ch, M, T, K, N>
where T: Ord, K: Kind, M: RawMutex,

Source

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

Receive the next value.

See PriorityChannel::receive().

Source

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

Attempt to immediately receive the next value.

See PriorityChannel::try_receive()

Source

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 PriorityChannel::poll_ready_to_receive()

Source

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

Poll the channel for the next item

See PriorityChannel::poll_receive()

Source

pub const fn capacity(&self) -> usize

Returns the maximum number of elements the channel can hold.

See PriorityChannel::capacity()

Source

pub fn free_capacity(&self) -> usize

Returns the free capacity of the channel.

See PriorityChannel::free_capacity()

Source

pub fn clear(&self)

Clears all elements in the channel.

See PriorityChannel::clear()

Source

pub fn len(&self) -> usize

Returns the number of elements currently in the channel.

See PriorityChannel::len()

Source

pub fn is_empty(&self) -> bool

Returns whether the channel is empty.

See PriorityChannel::is_empty()

Source

pub fn is_full(&self) -> bool

Returns whether the channel is full.

See PriorityChannel::is_full()

Trait Implementations§

Source§

impl<'ch, M, T, K, const N: usize> Clone for Receiver<'ch, M, T, K, N>
where T: Ord, K: Kind, M: RawMutex,

Source§

fn clone(&self) -> Self

Returns a copy 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<'ch, M, T, K, const N: usize> From<Receiver<'ch, M, T, K, N>> for DynamicReceiver<'ch, T>
where T: Ord, K: Kind, M: RawMutex,

Source§

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

Converts to this type from the input type.
Source§

impl<'ch, M, T, K, const N: usize> Copy for Receiver<'ch, M, T, K, N>
where T: Ord, K: Kind, M: RawMutex,

Auto Trait Implementations§

§

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

§

impl<'ch, M, T, K, const N: usize> !RefUnwindSafe for Receiver<'ch, M, T, K, N>

§

impl<'ch, M, T, K, const N: usize> Send for Receiver<'ch, M, T, K, N>
where M: Sync, K: Send, T: Send,

§

impl<'ch, M, T, K, const N: usize> Sync for Receiver<'ch, M, T, K, N>
where M: Sync, K: Send, T: Send,

§

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

§

impl<'ch, M, T, K, const N: usize> !UnwindSafe for Receiver<'ch, M, T, K, 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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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, 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.