pub struct Giver { /* private fields */ }
Expand description
An entity that gives a value when wanted.
Implementations§
source§impl Giver
impl Giver
sourcepub fn want<'a>(&'a mut self) -> impl Future<Output = Result<(), Closed>> + 'a
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.
sourcepub fn poll_want(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Closed>>
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 calledwant()
, this returnsAsync::Ready(())
. - If the
Taker
has not calledwant()
since last poll, this returnsAsync::NotReady
, and parks the current task to be notified when theTaker
does callwant()
. - If the
Taker
has canceled (or dropped), this returnsClosed
.
After knowing that the Taker is wanting, the state can be reset by
calling give
.
sourcepub fn give(&self) -> bool
pub fn give(&self) -> bool
Mark the state as idle, if the Taker currently is wanting.
Returns true if Taker was wanting, false otherwise.
sourcepub fn is_wanting(&self) -> bool
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.
sourcepub fn is_canceled(&self) -> bool
pub fn is_canceled(&self) -> bool
Check if the Taker
has canceled interest without parking a task.
Converts this into a SharedGiver
.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Giver
impl Send for Giver
impl Sync for Giver
impl Unpin for Giver
impl !UnwindSafe for Giver
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more