Struct hybridfutex::WaitFuture

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

A future representing a thread that is waiting for a notification from another thread using a HybridFutex synchronization primitive.

Trait Implementations

impl<'a> Debug for WaitFuture<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for WaitFuture<'a>

fn drop(&mut self)

Drops the future, checking whether it has been polled before and panicking if it has not. This is to prevent potential memory leaks if the future is dropped before being polled.

impl<'a> Future for WaitFuture<'a>

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

Polls the future, returning Poll::Pending if the future is still waiting for a notification, and Poll::Ready(()) if the future has been notified.

If the future has not yet been polled, this method increments the counter of the HybridFutex that the future is waiting on to indicate that the current thread is waiting. If the counter is already negative, the future immediately resolves and returns Poll::Ready(()). Otherwise, the method pushes a new AsyncWaiter onto the queue of waiters for the HybridFutex, and returns Poll::Pending.

If the future has already been polled and the value of the state field is 1, this method simply returns Poll::Pending without modifying the state or the queue of waiters.

If the future has already been notified and the value of the state field is !0, this method returns Poll::Ready(()) without modifying the state or the queue of waiters.

type Output = ()

The type of value produced on completion.