summaryrefslogtreecommitdiffstats
path: root/futures/src
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón <hector0193@gmail.com>2020-04-05 18:32:51 +0200
committerLibravatar GitHub <noreply@github.com>2020-04-05 18:32:51 +0200
commitad0a6c4c10afe6dceed52b953cd90aa04e91098a (patch)
treef9bf96a234e5adfdb86120882173cc73ed2a0110 /futures/src
parentfd064ff9902786e2ce83cb9cafce34029447055c (diff)
parent335ad1dd1d5bfa65e9a3174fcecd9e1fe871646d (diff)
downloadiced-ad0a6c4c10afe6dceed52b953cd90aa04e91098a.tar.gz
iced-ad0a6c4c10afe6dceed52b953cd90aa04e91098a.tar.bz2
iced-ad0a6c4c10afe6dceed52b953cd90aa04e91098a.zip
Merge pull request #259 from robjtede/docs/feature-flags
reference feature flags in docs
Diffstat (limited to 'futures/src')
-rw-r--r--futures/src/executor/async_std.rs1
-rw-r--r--futures/src/executor/thread_pool.rs1
-rw-r--r--futures/src/executor/tokio.rs1
-rw-r--r--futures/src/lib.rs2
4 files changed, 5 insertions, 0 deletions
diff --git a/futures/src/executor/async_std.rs b/futures/src/executor/async_std.rs
index 27949e31..471be369 100644
--- a/futures/src/executor/async_std.rs
+++ b/futures/src/executor/async_std.rs
@@ -3,6 +3,7 @@ use crate::Executor;
use futures::Future;
/// An `async-std` runtime.
+#[cfg_attr(docsrs, doc(cfg(feature = "async-std")))]
#[derive(Debug)]
pub struct AsyncStd;
diff --git a/futures/src/executor/thread_pool.rs b/futures/src/executor/thread_pool.rs
index 1ec5bf69..a6c6168e 100644
--- a/futures/src/executor/thread_pool.rs
+++ b/futures/src/executor/thread_pool.rs
@@ -3,6 +3,7 @@ use crate::Executor;
use futures::Future;
/// A thread pool runtime for futures.
+#[cfg_attr(docsrs, doc(cfg(feature = "thread-pool")))]
pub type ThreadPool = futures::executor::ThreadPool;
impl Executor for futures::executor::ThreadPool {
diff --git a/futures/src/executor/tokio.rs b/futures/src/executor/tokio.rs
index 20802ceb..a730bce8 100644
--- a/futures/src/executor/tokio.rs
+++ b/futures/src/executor/tokio.rs
@@ -3,6 +3,7 @@ use crate::Executor;
use futures::Future;
/// A `tokio` runtime.
+#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
pub type Tokio = tokio::runtime::Runtime;
impl Executor for Tokio {
diff --git a/futures/src/lib.rs b/futures/src/lib.rs
index 79178931..966a9cdc 100644
--- a/futures/src/lib.rs
+++ b/futures/src/lib.rs
@@ -4,6 +4,8 @@
#![deny(unused_results)]
#![forbid(unsafe_code)]
#![forbid(rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
pub use futures;
mod command;