Put futues::timeout behind unstable feature

Author: Stjepan Glavina

.travis.yml

@@ -23,8 +23,8 @@ before_script:
   - cargo install-update -a
 
 script:
-  - if ![[ -n "$BUILD_BOOK" ]]; then cargo check --all --benches --bins --examples --tests && cargo test --all; fi
-  - if  [[ -n "$BUILD_BOOK" ]]; then cargo test  --all --benches --bins --examples --tests; fi
+  - if ![[ -n "$BUILD_BOOK" ]]; then cargo check --features unstable --all --benches --bins --examples --tests && cargo test --features unstable --all; fi
+  - if  [[ -n "$BUILD_BOOK" ]]; then cargo test  --features unstable --all --benches --bins --examples --tests; fi
   - cargo fmt --all -- --check
   - if  [[ -n "$BUILD_DOCS" ]]; then cargo doc --features docs; fi
   - if  [[ -n "$BUILD_BOOK" ]]; then mdbook build docs && mdbook test -L ./target/debug/deps docs; fi

Cargo.toml

@@ -21,6 +21,7 @@ rustdoc-args = ["--cfg", "feature=\"docs\""]
 
 [features]
 docs = []
+unstable = []
 
 [dependencies]
 async-task = "1.0.0"

src/future/mod.rs

@@ -3,10 +3,17 @@
 #[doc(inline)]
 pub use std::future::Future;
 
+use cfg_if::cfg_if;
+
 pub use pending::pending;
 pub use ready::ready;
-pub use timeout::{timeout, TimeoutError};
 
 mod pending;
 mod ready;
-mod timeout;
+
+cfg_if! {
+    if #[cfg(any(feature = "unstable", feature = "docs"))] {
+        mod timeout;
+        pub use timeout::{timeout, TimeoutError};
+    }
+}

src/future/timeout.rs

@@ -4,7 +4,6 @@ use std::pin::Pin;
 use std::time::Duration;
 
 use futures_timer::Delay;
-use pin_utils::unsafe_pinned;
 
 use crate::future::Future;
 use crate::task::{Context, Poll};
@@ -14,7 +13,6 @@ use crate::task::{Context, Poll};
 /// # Examples
 ///
 /// ```
-/// # #![feature(async_await)]
 /// # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
 /// #
 /// use std::time::Duration;
@@ -27,6 +25,7 @@ use crate::task::{Context, Poll};
 /// #
 /// # Ok(()) }) }
 /// ```
+#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
 pub async fn timeout<F, T>(dur: Duration, f: F) -> Result<T, TimeoutError>
 where
     F: Future<Output = T>,
@@ -47,8 +46,8 @@ struct TimeoutFuture<F> {
 }
 
 impl<F> TimeoutFuture<F> {
-    unsafe_pinned!(future: F);
-    unsafe_pinned!(delay: Delay);
+    pin_utils::unsafe_pinned!(future: F);
+    pin_utils::unsafe_pinned!(delay: Delay);
 }
 
 impl<F: Future> Future for TimeoutFuture<F> {
@@ -58,16 +57,19 @@ impl<F: Future> Future for TimeoutFuture<F> {
         match self.as_mut().future().poll(cx) {
             Poll::Ready(v) => Poll::Ready(Ok(v)),
             Poll::Pending => match self.delay().poll(cx) {
-                Poll::Ready(_) => Poll::Ready(Err(TimeoutError)),
+                Poll::Ready(_) => Poll::Ready(Err(TimeoutError { _priv: () })),
                 Poll::Pending => Poll::Pending,
             },
         }
     }
 }
 
 /// An error returned when a future times out.
+#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
-pub struct TimeoutError;
+pub struct TimeoutError {
+    _priv: (),
+}
 
 impl Error for TimeoutError {}