Struct Consumer 

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

The consuming side of a shared state channel.

Consumers have read-only access to the shared value and are notified when a producer modifies it. Cloning a consumer increments the consumer reference count. When the last consumer is dropped, all waiters (e.g. Producer::unused) are notified.

Implementations

impl<T> Consumer<T>

pub fn poll<F, R>(&self, waiter: &Waiter, f: F) -> Poll<Result<R, Ref<'_, T>>>

where F: FnMut(&Ref<'_, T>) -> Poll<R>,

Poll the shared state with a closure.

Calls f with a Ref. If f returns Poll::Pending and the channel is still open, registers the Waiter for notification. Returns Err(Ref) if the channel has been closed while the condition returned by f is still pending.

pub fn poll_closed(&self, waiter: &Waiter) -> Poll<()>

Poll for channel closure, registering the waiter if still open.

pub async fn wait<F, R>(&self, f: F) -> Result<R, Ref<'_, T>>

where F: FnMut(&Ref<'_, T>) -> Poll<R> + Unpin, R: Unpin,

Wait for the closure to return Poll::Ready, re-polling on each state change.

Returns Ok(R) when the closure returns Poll::Ready, or Err(Ref) with read-only access to the final state if the channel closes first.

pub async fn closed(&self)

Wait until the channel is closed.

pub fn produce(&self) -> Option<Producer<T>>

Upgrade to a Producer, returning None if the state is already closed.

pub fn read(&self) -> Ref<'_, T>

Get read-only access to the shared state.

pub fn same_channel(&self, other: &Self) -> bool

Returns true if both consumers share the same underlying state.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Drop for Consumer<T>

fn drop(&mut self)

Executes the destructor for this type.