diff options
author | Juan Alvarez <j@yabit.io> | 2020-10-01 02:24:33 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-01 09:24:33 +0200 |
commit | 53ccfc1fd694ee70c7a4d1e7af09a856bafb49e5 (patch) | |
tree | 66f0b4c089729616b57bbb69b0a6351b45a0c898 /tokio/src/time/interval.rs | |
parent | 971ed2c6df9cb3bf3543a9c780662a0b4d1a8d40 (diff) |
time: introduce `sleep` and `sleep_until` functions (#2826)
Diffstat (limited to 'tokio/src/time/interval.rs')
-rw-r--r-- | tokio/src/time/interval.rs | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/tokio/src/time/interval.rs b/tokio/src/time/interval.rs index 52e081ce..5f05b2f9 100644 --- a/tokio/src/time/interval.rs +++ b/tokio/src/time/interval.rs @@ -1,5 +1,5 @@ use crate::future::poll_fn; -use crate::time::{delay_until, Delay, Duration, Instant}; +use crate::time::{sleep_until, Delay, Duration, Instant}; use std::future::Future; use std::pin::Pin; @@ -36,12 +36,12 @@ use std::task::{Context, Poll}; /// /// A simple example using `interval` to execute a task every two seconds. /// -/// The difference between `interval` and [`delay_for`] is that an `interval` +/// The difference between `interval` and [`sleep`] is that an `interval` /// measures the time since the last tick, which means that `.tick().await` /// may wait for a shorter time than the duration specified for the interval /// if some time has passed between calls to `.tick().await`. /// -/// If the tick in the example below was replaced with [`delay_for`], the task +/// If the tick in the example below was replaced with [`sleep`], the task /// would only be executed once every three seconds, and not every two /// seconds. /// @@ -50,7 +50,7 @@ use std::task::{Context, Poll}; /// /// async fn task_that_takes_a_second() { /// println!("hello"); -/// time::delay_for(time::Duration::from_secs(1)).await +/// time::sleep(time::Duration::from_secs(1)).await /// } /// /// #[tokio::main] @@ -63,7 +63,7 @@ use std::task::{Context, Poll}; /// } /// ``` /// -/// [`delay_for`]: crate::time::delay_for() +/// [`sleep`]: crate::time::sleep() pub fn interval(period: Duration) -> Interval { assert!(period > Duration::new(0, 0), "`period` must be non-zero."); @@ -101,7 +101,7 @@ pub fn interval_at(start: Instant, period: Duration) -> Interval { assert!(period > Duration::new(0, 0), "`period` must be non-zero."); Interval { - delay: delay_until(start), + delay: sleep_until(start), period, } } |