Struct Waiter

pub struct Waiter<T>(/* private fields */);

Waiter waits for a value that has been published by Publisher. A Waiter can be cloned and cloned instances all receive the same published value.

Implementations

impl<T> Waiter<T>

pub fn wait_for_value(&self) -> &T

Wait for the published value and return an immutable reference to it.

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

Attempt to get an immutable reference to the value, and return None if the value has not been published yet. This is guaranteed to succeed if wait_for_value has previously returned.

pub fn into_value(self) -> Result<T, Waiter<T>>

Attempt to gain exclusive ownership of the underlying value. This will only succeed if a value has been published and this is the only Waiter remaining. Otherwise, an Err is returned with the same Waiter that was passed in.

Trait Implementations

impl<T> Clone for Waiter<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 Waiter<T>

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

Formats the value using the given formatter.