summaryrefslogtreecommitdiffstats
path: root/tokio/src/prelude.rs
diff options
context:
space:
mode:
Diffstat (limited to 'tokio/src/prelude.rs')
-rw-r--r--tokio/src/prelude.rs28
1 files changed, 28 insertions, 0 deletions
diff --git a/tokio/src/prelude.rs b/tokio/src/prelude.rs
new file mode 100644
index 00000000..17b2469d
--- /dev/null
+++ b/tokio/src/prelude.rs
@@ -0,0 +1,28 @@
+//! A "prelude" for users of the `tokio` crate.
+//!
+//! This prelude is similar to the standard library's prelude in that you'll
+//! almost always want to import its entire contents, but unlike the standard
+//! library's prelude you'll have to do so manually:
+//!
+//! ```
+//! use tokio::prelude::*;
+//! ```
+//!
+//! The prelude may grow over time as additional items see ubiquitous use.
+
+#[cfg(feature = "io")]
+pub use tokio_io::{AsyncRead, AsyncWrite};
+
+pub use util::{FutureExt, StreamExt};
+
+pub use std::io::{Read, Write};
+
+pub use futures::{future, stream, task, Async, AsyncSink, Future, IntoFuture, Poll, Sink, Stream};
+
+#[cfg(feature = "async-await-preview")]
+#[doc(inline)]
+pub use tokio_async_await::{
+ io::{AsyncReadExt, AsyncWriteExt},
+ sink::SinkExt,
+ stream::StreamExt as StreamAsyncExt,
+};