#waker #counter

noop-waker

A waker that does nothing

1 unstable release

0.1.0 Jul 26, 2021
Download history 40/week @ 2023-05-28 31/week @ 2023-06-04 69/week @ 2023-06-11 174/week @ 2023-06-18 103/week @ 2023-06-25 58/week @ 2023-07-02 33/week @ 2023-07-09 35/week @ 2023-07-16 40/week @ 2023-07-23 24/week @ 2023-07-30 50/week @ 2023-08-06 50/week @ 2023-08-13 116/week @ 2023-08-20 1105/week @ 2023-08-27 5774/week @ 2023-09-03 4790/week @ 2023-09-10

11,788 downloads per month
Used in async-quic

MIT/Apache

7KB

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);

No runtime deps