Struct Giver

pub struct Giver { /* private fields */ }

An entity that gives a value when wanted.

Implementations

impl Giver

pub fn want<'a>(&'a mut self) -> impl Future<Output = Result<(), Closed>> + 'a

Returns a Future that fulfills when the Taker has done some action.

pub fn poll_want(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Closed>>

Poll whether the Taker has registered interest in another value.

• If the Taker has called want(), this returns Async::Ready(()).
• If the Taker has not called want() since last poll, this returns Async::NotReady, and parks the current task to be notified when the Taker does call want().
• If the Taker has canceled (or dropped), this returns Closed.

After knowing that the Taker is wanting, the state can be reset by calling give.

pub fn give(&self) -> bool

Mark the state as idle, if the Taker currently is wanting.

Returns true if Taker was wanting, false otherwise.

pub fn is_wanting(&self) -> bool

Check if the Taker has called want() without parking a task.

This is safe to call outside of a futures task context, but other means of being notified is left to the user.

pub fn is_canceled(&self) -> bool

Check if the Taker has canceled interest without parking a task.

pub fn shared(self) -> SharedGiver

Converts this into a SharedGiver.

Trait Implementations

impl Debug for Giver

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

Formats the value using the given formatter.