Struct update_channel::Receiver

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

The receiving half of an update channel

This struct holds an internal buffer in which data is held. The buffer can then be updated with recv_update, take_update usw.

Implementations

impl<T> Receiver<T>

pub fn take_update(&mut self) -> Result<Option<T>, ReceiveError>

Takes the new updated value and make it unavailable for all other receivers. Returns the previous value inside the buffer if the value has not been taken by another receiver, otherwise Returns Ok(None)

pub unsafe fn take_update_unsafe(&self) -> Result<Option<T>, ReceiveError>

Same as Receiver::take_update but without borrowing mutably. This might open new possiblities, but it might result in undefined behavior if there are immutable borrows created with Receiver::borrow

pub fn borrow(&self) -> &T

Get the value saved in the internal buffer without updating as borrow

pub fn borrow_mut(&mut self) -> &mut T

Get a mutable reference to the value in the buffer

pub fn into_inner(self) -> T

Unwrap the value contained in the buffer of this receiver

pub fn borrow_locked<'a>(
    &'a self
) -> Result<RwLockReadGuard<'a, Option<T>>, ReceiveError>

Get the latest value (not the value in the buffer) and return it while holding a read lock to it. It is not recommended to hold on to this lock for long.

pub fn has_updater(&self) -> bool

Checks if at least one updater exists

impl<T> Receiver<T> where
    T: Clone, 

pub fn recv_update(&mut self) -> Result<Option<T>, ReceiveError>

Clone the latest updated value into the internal buffer. Returns the previous value inside the buffer if the value has not been taken by another receiver

pub unsafe fn recv_update_unsafe(&self) -> Result<Option<T>, ReceiveError>

Same as Receiver::recv_update but without borrowing mutably. This might open new possiblities, but it might result in undefined behavior if there are immutable borrows created with Receiver::borrow

pub fn get_cloned(&self) -> Result<Option<T>, ReceiveError>

Get the latest value (not the value in the buffer) cloned

impl<T> Receiver<T> where
    T: Clone + PartialEq, 

pub fn recv_update_checked(&mut self) -> Result<Option<T>, ReceiveError>

Updates the internal buffer by cloning the updated value if it is different from the current held value

pub unsafe fn recv_update_checked_unsafe(
    &self
) -> Result<Option<T>, ReceiveError>

Same as Receiver::recv_update_checked but without borrowing mutably. This might open new possiblities, but it might result in undefined behavior if there are immutable borrows created with Receiver::borrow

pub fn take_update_checked(&mut self) -> Result<Option<T>, ReceiveError>

Updates the internal buffer by taking the updated value if it is different from the current held value

pub unsafe fn take_update_checked_unsafe(
    &self
) -> Result<Option<T>, ReceiveError>

Same as Receiver::recv_update_checked but without borrowing mutably. This might open new possiblities, but it might result in undefined behavior if there are immutable borrows created with Receiver::borrow

Trait Implementations

impl<T> Clone for Receiver<T> where
    T: Clone, 

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Send for Receiver<T> where
    T: Clone,