summaryrefslogtreecommitdiffstats
path: root/tokio/src/time/mod.rs
diff options
context:
space:
mode:
authorCarl Lerche <me@carllerche.com>2019-12-22 12:55:09 -0800
committerGitHub <noreply@github.com>2019-12-22 12:55:09 -0800
commit7b53b7b659fe1feeb30e768cad8fdadf9531beb6 (patch)
treece4020f1e63ee9ecaa822ccd9961de6542bb91c3 /tokio/src/time/mod.rs
parent99fa93bf0ea504413f6e53b46fbefdee4c0a0904 (diff)
doc: fill out `fs` and remove html links (#2015)
also add an async version of `fs::canonicalize`
Diffstat (limited to 'tokio/src/time/mod.rs')
-rw-r--r--tokio/src/time/mod.rs28
1 files changed, 10 insertions, 18 deletions
diff --git a/tokio/src/time/mod.rs b/tokio/src/time/mod.rs
index 4193dc15..24aae11e 100644
--- a/tokio/src/time/mod.rs
+++ b/tokio/src/time/mod.rs
@@ -5,25 +5,24 @@
//! This module provides a number of types for executing code after a set period
//! of time.
//!
-//! * [`Delay`][Delay] is a future that does no work and completes at a specific `Instant`
+//! * `Delay` is a future that does no work and completes at a specific `Instant`
//! in time.
//!
-//! * [`Interval`][Interval] is a stream yielding a value at a fixed period. It
-//! is initialized with a `Duration` and repeatedly yields each time the
-//! duration elapses.
+//! * `Interval` is a stream yielding a value at a fixed period. It is
+//! initialized with a `Duration` and repeatedly yields each time the duration
+//! elapses.
//!
-//! * [`Timeout`][Timeout]: Wraps a future or stream, setting an upper bound to the
-//! amount of time it is allowed to execute. If the future or stream does not
+//! * `Timeout`: Wraps a future or stream, setting an upper bound to the amount
+//! of time it is allowed to execute. If the future or stream does not
//! complete in time, then it is canceled and an error is returned.
//!
-//! * [`DelayQueue`]: A queue where items are returned once the requested delay
+//! * `DelayQueue`: A queue where items are returned once the requested delay
//! has expired.
//!
//! These types are sufficient for handling a large number of scenarios
//! involving time.
//!
-//! These types must be used from within the context of the
-//! [`Runtime`][runtime].
+//! These types must be used from within the context of the `Runtime`.
//!
//! # Examples
//!
@@ -43,8 +42,8 @@
//! ```
//!
//! Require that an operation takes no more than 300ms. Note that this uses the
-//! [`timeout`][ext] function on the [`FutureExt`][ext] trait. This trait is
-//! included in the prelude.
+//! `timeout` function on the `FutureExt` trait. This trait is included in the
+//! prelude.
//!
//! ```
//! use tokio::time::{timeout, Duration};
@@ -61,13 +60,6 @@
//! }
//! # }
//! ```
-//!
-//! [runtime]: ../runtime/struct.Runtime.html
-//! [ext]: ../util/trait.FutureExt.html#method.timeout
-//! [Timeout]: struct.Timeout.html
-//! [Delay]: struct.Delay.html
-//! [Interval]: struct.Interval.html
-//! [`DelayQueue`]: struct.DelayQueue.html
mod clock;
pub(crate) use self::clock::Clock;