Struct awaitable::Awaitable

pub struct Awaitable<Input, Output>(_);

Awaitable guarantees that there is no spurious wakeup

Implementations

impl<Input, Output> Awaitable<Input, Output>

pub fn new() -> Self

Create an uninitialized Awaitable.

Must be reset before it can be used.

pub const fn const_new() -> Self

Available on crate feature parking_lot only.

Create an uninitialized Awaitable.

Must be reset before it can be used.

impl<Input, Output> Awaitable<Input, Output>

pub fn reset(&self, input: Option<Input>)

Reset Awaitable to its initial state.

After this call, install_waker, take_input and done can be called.

pub fn install_waker(&self, waker: Waker) -> Result<bool, Error>

Return true if the task is already done.

** install_waker must not be called after take_output is called. **

pub fn take_input(&self) -> Result<Option<Input>, Error>

**take_input must not be called after take_output is called.

pub fn done(&self, value: Output) -> Result<(), Error>

done must be only called once on one instance of Awaitable.

done must not be called after take_output is called.

pub fn take_output(&self) -> Option<Output>

Return Some(output) if the awaitable is done.

pub fn is_done(&self) -> bool

Return true if current state is Done.

pub fn is_consumed(&self) -> bool

Return true if current state is Consumed.

Trait Implementations

impl<Input: Debug, Output: Debug> Debug for Awaitable<Input, Output>

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

Formats the value using the given formatter.

impl<Input, Output> Default for Awaitable<Input, Output>

fn default() -> Self

Returns the “default value” for a type.