summaryrefslogtreecommitdiffstats
path: root/tokio-timer
diff options
context:
space:
mode:
Diffstat (limited to 'tokio-timer')
-rw-r--r--tokio-timer/src/lib.rs5
-rw-r--r--tokio-timer/src/timeout.rs12
2 files changed, 11 insertions, 6 deletions
diff --git a/tokio-timer/src/lib.rs b/tokio-timer/src/lib.rs
index 4fa93385..a8cce26e 100644
--- a/tokio-timer/src/lib.rs
+++ b/tokio-timer/src/lib.rs
@@ -6,7 +6,10 @@
unreachable_pub
)]
#![deny(intra_doc_link_resolution_failure)]
-#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
+#![doc(test(
+ no_crate_inject,
+ attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
+))]
//! Utilities for tracking time.
//!
diff --git a/tokio-timer/src/timeout.rs b/tokio-timer/src/timeout.rs
index 250dc828..0b9d0110 100644
--- a/tokio-timer/src/timeout.rs
+++ b/tokio-timer/src/timeout.rs
@@ -38,7 +38,7 @@ use std::time::{Duration, Instant};
/// use std::thread;
/// use std::time::Duration;
///
-/// # async fn dox() {
+/// # async fn dox() -> Result<(), Box<dyn std::error::Error>> {
/// let (mut tx, rx) = mpsc::unbounded_channel();
///
/// thread::spawn(move || {
@@ -54,7 +54,8 @@ use std::time::{Duration, Instant};
/// });
///
/// // Wrap the future with a `Timeout` set to expire in 10 milliseconds.
-/// process.timeout(Duration::from_millis(10)).await;
+/// process.timeout(Duration::from_millis(10)).await?;
+/// # Ok(())
/// # }
/// ```
///
@@ -99,13 +100,14 @@ impl<T> Timeout<T> {
///
/// use std::time::Duration;
///
- /// # async fn dox() {
+ /// # async fn dox() -> Result<(), Box<dyn std::error::Error>> {
/// let (tx, rx) = oneshot::channel();
/// # tx.send(()).unwrap();
///
/// // Wrap the future with a `Timeout` set to expire in 10 milliseconds.
- /// Timeout::new(rx, Duration::from_millis(10)).await;
- /// }
+ /// Timeout::new(rx, Duration::from_millis(10)).await??;
+ /// # Ok(())
+ /// # }
/// ```
pub fn new(value: T, timeout: Duration) -> Timeout<T> {
let delay = Delay::new_timeout(now() + timeout, timeout);