pub struct Receiver<'ch, M, T, const N: usize>where
M: RawMutex,{ /* private fields */ }
Expand description
Receive-only access to a Channel
.
Implementations§
source§impl<'ch, M, T, const N: usize> Receiver<'ch, M, T, N>where
M: RawMutex,
impl<'ch, M, T, const N: usize> Receiver<'ch, M, T, N>where
M: RawMutex,
sourcepub fn receive(&self) -> ReceiveFuture<'_, M, T, N> ⓘ
pub fn receive(&self) -> ReceiveFuture<'_, M, T, N> ⓘ
Receive the next value.
See Channel::receive()
.
sourcepub fn ready_to_receive(&self) -> ReceiveReadyFuture<'_, M, T, N> ⓘ
pub fn ready_to_receive(&self) -> ReceiveReadyFuture<'_, M, T, N> ⓘ
Is a value ready to be received in the channel
sourcepub fn try_receive(&self) -> Result<T, TryReceiveError>
pub fn try_receive(&self) -> Result<T, TryReceiveError>
Attempt to immediately receive the next value.
sourcepub fn poll_ready_to_receive(&self, cx: &mut Context<'_>) -> Poll<()>
pub fn poll_ready_to_receive(&self, cx: &mut Context<'_>) -> Poll<()>
Allows a poll_fn to poll until the channel is ready to receive
sourcepub fn poll_receive(&self, cx: &mut Context<'_>) -> Poll<T>
pub fn poll_receive(&self, cx: &mut Context<'_>) -> Poll<T>
Poll the channel for the next item
sourcepub const fn capacity(&self) -> usize
pub const fn capacity(&self) -> usize
Returns the maximum number of elements the channel can hold.
sourcepub fn free_capacity(&self) -> usize
pub fn free_capacity(&self) -> usize
Returns the free capacity of the channel.
sourcepub fn clear(&self)
pub fn clear(&self)
Clears all elements in the channel.
See Channel::clear()
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the number of elements currently in the channel.
See Channel::len()
Trait Implementations§
source§impl<'ch, M, T, const N: usize> From<Receiver<'ch, M, T, N>> for DynamicReceiver<'ch, T>where
M: RawMutex,
impl<'ch, M, T, const N: usize> From<Receiver<'ch, M, T, N>> for DynamicReceiver<'ch, T>where
M: RawMutex,
impl<'ch, M, T, const N: usize> Copy for Receiver<'ch, M, T, N>where
M: RawMutex,
Auto Trait Implementations§
impl<'ch, M, T, const N: usize> Freeze for Receiver<'ch, M, T, N>
impl<'ch, M, T, const N: usize> !RefUnwindSafe for Receiver<'ch, M, T, N>
impl<'ch, M, T, const N: usize> Send for Receiver<'ch, M, T, N>
impl<'ch, M, T, const N: usize> Sync for Receiver<'ch, M, T, N>
impl<'ch, M, T, const N: usize> Unpin for Receiver<'ch, M, T, N>
impl<'ch, M, T, const N: usize> !UnwindSafe for Receiver<'ch, M, T, N>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)