kio 0.5.2

Easy async
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! kio integration for tokio.
//!
//! Behind the `tokio` feature. Wraps a [`tokio::time::Sleep`] so a `poll_*` function can
//! drive it against a [`Waiter`], keeping the rest of kio runtime-free.

use std::pin::Pin;
use std::task::Poll;

use crate::Waiter;

/// A tokio sleep driven by kio's poll model.
///
/// Construct it once for a deadline (`Sleep::new(tokio::time::sleep_until(deadline))`), then
/// [`poll`](Self::poll) it against a [`Waiter`] each time your `poll_*` runs. Reading the
/// clock through `tokio::time` means a `tokio::time::pause()` test advances it in step.
#[deprecated(note = "use kio::time::Deadline, which also works on wasm and can be re-armed in place")]
pub struct Sleep {
	inner: Pin<Box<::tokio::time::Sleep>>,
}

#[allow(deprecated)]
impl Sleep {
	/// Wrap a tokio sleep future.
	pub fn new(sleep: ::tokio::time::Sleep) -> Self {
		Self { inner: Box::pin(sleep) }
	}

	/// Poll the sleep, registering `waiter` so the poll re-fires once it elapses.
	pub fn poll(&mut self, waiter: &Waiter) -> Poll<()> {
		waiter.poll_future(self.inner.as_mut())
	}

	/// Wait until the sleep elapses.
	pub async fn wait(&mut self) {
		crate::wait(|waiter| self.poll(waiter)).await
	}
}

#[cfg(all(test, not(loom)))]
#[allow(deprecated)]
mod tests {
	use super::*;
	use ::tokio::time::Instant;
	use std::time::Duration;

	#[::tokio::test(start_paused = true)]
	async fn sleep_fires_at_its_deadline() {
		let deadline = Instant::now() + Duration::from_millis(50);
		let mut sleep = Sleep::new(::tokio::time::sleep_until(deadline));
		sleep.wait().await;
		assert!(Instant::now() >= deadline, "returned before the deadline");
	}
}