Merge pull request #33 from async-rs/remove-time-module

Remove time module

Author: skade

examples/stdin-timeout.rs

@@ -8,13 +8,15 @@ use async_std::io;
 use async_std::task;
 
 fn main() -> io::Result<()> {
+    // This async scope times out after 5 seconds.
     task::block_on(io::timeout(Duration::from_secs(5), async {
         let stdin = io::stdin();
 
+        // Read a line from the standard input and display it.
         let mut line = String::new();
         stdin.read_line(&mut line).await?;
+        dbg!(line);
 
-        print!("Got line: {}", line);
         Ok(())
     }))
 }

src/future/pending.rs

@@ -8,10 +8,13 @@
 /// use std::time::Duration;
 ///
 /// use async_std::future::pending;
-/// use async_std::prelude::*;
+/// use async_std::io;
 ///
 /// let dur = Duration::from_secs(1);
-/// assert!(pending::<()>().timeout(dur).await.is_err());
+/// let fut = pending();
+///
+/// let res: io::Result<()> = io::timeout(dur, fut).await;
+/// assert!(res.is_err());
 /// #
 /// # }) }
 /// ```

src/future/ready.rs

@@ -10,9 +10,9 @@
 /// # #![feature(async_await)]
 /// # fn main() { async_std::task::block_on(async {
 /// #
-/// use async_std::future::ready;
+/// use async_std::future;
 ///
-/// assert_eq!(ready(10).await, 10);
+/// assert_eq!(future::ready(10).await, 10);
 /// #
 /// # }) }
 /// ```

src/lib.rs

@@ -75,6 +75,5 @@ pub mod prelude;
 pub mod stream;
 pub mod sync;
 pub mod task;
-pub mod time;
 
 pub(crate) mod utils;

src/prelude.rs

@@ -1,30 +1,6 @@
 //! The async prelude.
 //!
-//! The prelude re-exports the most commonly used traits in async programming.
-//!
-//! # Examples
-//!
-//! Import the prelude to use the [`timeout`] combinator:
-//!
-//! ```no_run
-//! # #![feature(async_await)]
-//! # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
-//! #
-//! use std::time::Duration;
-//!
-//! use async_std::io;
-//! use async_std::prelude::*;
-//!
-//! let stdin = io::stdin();
-//! let mut line = String::new();
-//! let dur = Duration::from_secs(5);
-//!
-//! stdin.read_line(&mut line).timeout(dur).await??;
-//! #
-//! # Ok(()) }) }
-//! ```
-//!
-//! [`timeout`]: ../time/trait.Timeout.html#method.timeout
+//! The prelude re-exports the most commonly used traits in this crate.
 
 #[doc(no_inline)]
 pub use crate::future::Future;
@@ -40,5 +16,3 @@ pub use crate::io::Write as _;
 pub use crate::stream::Stream;
 #[doc(no_inline)]
 pub use crate::task_local;
-#[doc(no_inline)]
-pub use crate::time::Timeout as _;

src/task/sleep.rs

@@ -1,8 +1,7 @@
 use std::time::Duration;
 
-use futures::future;
-
-use crate::time::Timeout;
+use crate::future;
+use crate::io;
 
 /// Sleeps for the specified amount of time.
 ///
@@ -27,5 +26,5 @@ use crate::time::Timeout;
 /// # }) }
 /// ```
 pub async fn sleep(dur: Duration) {
-    let _ = future::pending::<()>().timeout(dur).await;
+    let _: io::Result<()> = io::timeout(dur, future::pending()).await;
 }