Crate noop_waker

A waker that does nothing when it is woken. Useful for “now or never” type scenarioes where a future is unlikely to be polled more than once, or for “spinning” executors.

Example

A very inefficient implementation of the block_on function that polls the future over and over.

use core::{future::Future, hint::spin_loop, task::{Context, Poll}};
use futures_lite::future::poll_fn;
use noop_waker::noop_waker;
 
fn block_on<R>(f: impl Future<Output = R>) -> R {
    // pin the future to the stack
    futures_lite::pin!(f);
 
    // create the context
    let waker = noop_waker();
    let mut ctx = Context::from_waker(&waker);
 
    // poll future in a loop
    loop {
        match f.as_mut().poll(&mut ctx) {
            Poll::Ready(o) => return o,
            Poll::Pending => spin_loop(),
        }
    }
}
 
// this future returns pending 5 times before returning ready
 
let mut counter = 0;
let my_future = poll_fn(|ctx| {
    if counter < 5 {
        counter += 1;
        ctx.waker().wake_by_ref();
        Poll::Pending
    } else {
        Poll::Ready(7)
    }
});
 
assert_eq!(block_on(my_future), 7);

Functions

noop_waker

The whole point. Returns a waker that does nothing.