Merge pull request #804 from async-rs/tokio02-feature

Author: dignifiedquire

.github/workflows/ci.yml

@@ -110,6 +110,17 @@ jobs:
         command:  check
         args: --no-default-features --features alloc --target thumbv7m-none-eabi -Z avoid-dev-deps
 
+  check_tokio_02_feature:
+    name: Check tokio02 feature
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: check tokio02
+      uses: actions-rs/cargo@v1
+      with:
+        command:  check
+        args: --all --features tokio02
+
   cross:
     name: Cross compile
     runs-on: ubuntu-latest

Cargo.toml

@@ -51,6 +51,7 @@ alloc = [
   "futures-core/alloc",
   "pin-project-lite",
 ]
+tokio02 = ["smol/tokio02"]
 
 [dependencies]
 async-attributes = { version = "1.1.1", optional = true }
@@ -98,4 +99,4 @@ required-features = ["unstable"]
 
 [[example]]
 name = "surf-web"
-required-features = ["surf"]
+required-features = ["surf"]

src/lib.rs

@@ -214,6 +214,15 @@
 //! features = ["attributes"]
 //! ```
 //!
+//! Compatibility with the `tokio` runtime is possible using the `tokio02`
+//! Cargo feature:
+//!
+//! ```toml
+//! [dependencies.async-std]
+//! version = "1.6.0"
+//! features = ["tokio02"]
+//! ```
+//!
 //! Additionally it's possible to only use the core traits and combinators by
 //! only enabling the `std` Cargo feature:
 //!