Struct suspend::Listener

pub struct Listener<'a> { /* fields omitted */ }

The result of acquiring a Suspend using either Suspend::listen or Suspend::try_listen. It may be used to wait for a notification with .await or by parking the current thread.

Implementations

impl<'_> Listener<'_>

pub fn wait(&mut self)

Wait for a notification on the associated Suspend instance, parking the current thread until that time.

pub fn wait_deadline(&mut self, expire: Instant) -> bool

Wait for a notification on the associated Suspend instance, parking the current thread until the result is available or the deadline is reached. If a timeout occurs then false is returned, otherwise true.

pub fn wait_timeout(&self, timeout: Duration) -> bool

Wait for a notification on the associated Suspend instance, parking the current thread until the result is available or the timeout expires. If a timeout does occur then false is returned, otherwise true.

Trait Implementations

impl<'_> Drop for Listener<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Future for Listener<'a>

type Output = ()

The type of value produced on completion.

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

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