Struct want::Giver

source ·
pub struct Giver { /* private fields */ }
Expand description

An entity that gives a value when wanted.

Implementations§

source§

impl Giver

source

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

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

source

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.

source

pub fn give(&self) -> bool

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

Returns true if Taker was wanting, false otherwise.

source

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.

source

pub fn is_canceled(&self) -> bool

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

source

pub fn shared(self) -> SharedGiver

Converts this into a SharedGiver.

Trait Implementations§

source§

impl Debug for Giver

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Giver

§

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.