Struct Notified

pub struct Notified<'a> { /* private fields */ }

Future created from Notify::notified().

Implementations

impl<'a> Notified<'a>

pub fn enable(self: Pin<&mut Self>)

Enables to wait for a notification from Notify::notify_one or Notify::notify_all.

If there is permit from Notify::notify_one, this will consume it temporarily for future polling. If this Notified is dropped without further polling, the permit will be handed over to Notify in case of no new Notify::notify_all.

Notified::poll will enable this also.

pub fn detach(self) -> Notified<'a>

Detaches from rounds of Notify so it will not be notified until Notified::enable or Notified::poll.

Trait Implementations

impl Drop for Notified<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Future for Notified<'_>

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl Send for Notified<'_>

impl Sync for Notified<'_>