Struct Sender

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

A sender of a Watch channel.

For a simpler type definition, consider DynSender at the expense of some runtime performance due to dynamic dispatch.

Implementations

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

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

Converts the Sender into a DynSender.

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

pub fn send(&self, val: T)

Sends a new value to the Watch.

pub fn clear(&self)

Clears the value of the Watch. This will cause calls to Rcv::get to be pending.

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

Tries to retrieve the value of the Watch.

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

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

Tries to peek the current value of the Watch if it matches the predicate function f.

pub fn contains_value(&self) -> bool

Returns true if the Watch contains a value.

pub fn send_modify<F>(&self, f: F)

where F: Fn(&mut Option<T>),

Modify the value of the Watch using a closure.

pub fn send_if_modified<F>(&self, f: F)

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

Modify the value of the Watch using a closure. The closure must return true if the value was modified, which notifies all receivers.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

type Target = Snd<'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 Sender<'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<DynSender<'a, T>> for Sender<'a, M, T, N>

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

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