Struct Receiver

pub struct Receiver<'a, M: RawMutex, T: Clone, const N: usize>(/* private fields */);

A receiver of a Watch channel.

Implementations

impl<'a, M: RawMutex, T: Clone, const N: usize> Receiver<'a, M, T, N>

pub fn as_dyn(self) -> DynReceiver<'a, T>

Converts the Receiver into a DynReceiver.

Methods from Deref<Target = Rcv<'a, T, Watch<M, T, N>>>

pub async fn get(&mut self) -> T

Returns the current value of the Watch once it is initialized, marking it as seen.

Note: Futures do nothing unless you .await or poll them.

pub fn try_get(&mut self) -> Option<T>

Tries to get the current value of the Watch without waiting, marking it as seen.

pub async fn get_and<F>(&mut self, f: F) -> T

where F: Fn(&T) -> bool,

Returns the value of the Watch if it matches the predicate function f, or waits for it to match, marking it as seen.

Note: Futures do nothing unless you .await or poll them.

pub fn try_get_and<F>(&mut self, f: F) -> Option<T>

where F: Fn(&T) -> bool,

Tries to get the current value of the Watch if it matches the predicate function f without waiting, marking it as seen.

pub async fn changed(&mut self) -> T

Waits for the Watch to change and returns the new value, marking it as seen.

Note: Futures do nothing unless you .await or poll them.

pub fn try_changed(&mut self) -> Option<T>

Tries to get the new value of the watch without waiting, marking it as seen.

pub async fn changed_and<F>(&mut self, f: F) -> T

where F: Fn(&T) -> bool,

Waits for the Watch to change to a value which satisfies the predicate function f and returns the new value, marking it as seen.

Note: Futures do nothing unless you .await or poll them.

pub fn try_changed_and<F>(&mut self, f: F) -> Option<T>

where F: Fn(&T) -> bool,

Tries to get the new value of the watch which satisfies the predicate function f and returns the new value without waiting, marking it as seen.

pub fn contains_value(&self) -> bool

Checks if the Watch contains a value. If this returns true, then awaiting Rcv::get will return immediately.

Trait Implementations

impl<'a, M: RawMutex, T: Clone, const N: usize> Deref for Receiver<'a, M, T, N>

type Target = Rcv<'a, T, Watch<M, T, N>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, M: RawMutex, T: Clone, const N: usize> DerefMut for Receiver<'a, M, T, N>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, M: RawMutex, T: Clone, const N: usize> Into<DynReceiver<'a, T>> for Receiver<'a, M, T, N>

fn into(self) -> DynReceiver<'a, T>

Converts this type into the (usually inferred) input type.