Struct Receiver 

pub struct Receiver<T> { /* private fields */ }

Receives values from the associated Sender.

Instances are created by the channel function.

Implementations

impl<T> Receiver<T>

pub fn has_changed(&self) -> bool

Checks if this channel contains a message that this receiver has not yet seen. The new value is not marked as seen.

Although this method is called has_changed, it does not check new messages for equality, so this call will return true even if the new message is equal to the old message.

pub fn mark_seen(&mut self)

Marks the new value if it exists as seen.

pub fn changed(&mut self) -> Notification<'_, T>

Waits for a change notification, then marks the newest value as seen.

If the newest value in the channel has not yet been marked seen when this method is called, the method marks that value seen and returns immediately. If the newest value has already been marked seen, then the method sleeps until a new message is sent by the Sender connected to this Receiver, or until the Sender is dropped.

This method returns an error if and only if the Sender is dropped.

pub fn borrow(&self) -> ValueRef<'_, T>

Returns a reference to the most recently sent value.

This method does not mark the returned value as seen, so future calls to Self::changed may return immediately even if you have already seen the value with a call to borrow.

Care must be taken not to hold a ref, when the sender is setting a new value. This includes not holding a ref across await points and not explicitly yielding control to other fibers while holding a ref.

If the stored type supports internal mutability, it can be changed transparently (without notifying) for the watchers through the reference returned from this function. This is not an intended use case, but it is possible.

Consider using Self::get or Self::get_cloned instead.

pub fn get(&self) -> T

where T: Copy,

Returns a copy of the most recently sent value.

This method does not mark the returned value as seen, so future calls to Self::changed may return immediately even if you have already seen the value with a call to borrow.

pub fn get_cloned(&self) -> T

where T: Clone,

Returns the most recently sent value cloned.

This method does not mark the returned value as seen, so future calls to Self::changed may return immediately even if you have already seen the value with a call to borrow.

Trait Implementations

impl<T> Clone for Receiver<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Receiver<T>

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

Formats the value using the given formatter.