Initial commit
This commit is contained in:
commit
033c52f453
|
@ -0,0 +1 @@
|
|||
github: stjepang
|
|
@ -0,0 +1,51 @@
|
|||
name: Build and test
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
build_and_test:
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
rust: [nightly, beta, stable]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macOS')
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
if: startsWith(matrix.os, 'windows')
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(Get-Date -UFormat %V)"
|
||||
|
||||
- name: Install latest ${{ matrix.rust }}
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: ${{ matrix.rust }}
|
||||
profile: minimal
|
||||
override: true
|
||||
|
||||
- name: Run cargo check
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: --all --bins --examples --tests --all-features
|
||||
|
||||
- name: Run cargo check (without dev-dependencies to catch missing feature flags)
|
||||
if: startsWith(matrix.rust, 'nightly')
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: check
|
||||
args: -Z features=dev_dep
|
||||
|
||||
- name: Run cargo test
|
||||
uses: actions-rs/cargo@v1
|
||||
with:
|
||||
command: test
|
|
@ -0,0 +1,26 @@
|
|||
name: Lint
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
clippy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: stable
|
||||
profile: minimal
|
||||
components: clippy
|
||||
- uses: actions-rs/clippy-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
args: --all-features -- -W clippy::all
|
|
@ -0,0 +1,20 @@
|
|||
name: Security audit
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
security_audit:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Set current week of the year in environnement
|
||||
run: echo "::set-env name=CURRENT_WEEK::$(date +%V)"
|
||||
|
||||
- uses: actions-rs/audit-check@v1
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
@ -0,0 +1,2 @@
|
|||
/target
|
||||
Cargo.lock
|
|
@ -0,0 +1,3 @@
|
|||
# Version 0.1.0
|
||||
|
||||
- Initial version
|
|
@ -0,0 +1,19 @@
|
|||
[package]
|
||||
name = "async-compat"
|
||||
version = "0.1.0"
|
||||
authors = ["Stjepan Glavina <stjepang@gmail.com>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
futures-core = "0.3.5"
|
||||
futures-io = "0.3.5"
|
||||
once_cell = "1.4.1"
|
||||
pin-project-lite = "0.1.7"
|
||||
tokio = { version = "0.2.22", default-features = false, features = ["rt-core"] }
|
||||
|
||||
[dev-dependencies]
|
||||
blocking = "0.5.2"
|
||||
futures = "0.3.5"
|
||||
reqwest = "0.10.8"
|
||||
tokio = { version = "0.2.22", default-features = false, features = ["rt-core", "io-std", "io-util", "macros"] }
|
||||
warp = "0.2.4"
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
|
@ -0,0 +1,23 @@
|
|||
Permission is hereby granted, free of charge, to any
|
||||
person obtaining a copy of this software and associated
|
||||
documentation files (the "Software"), to deal in the
|
||||
Software without restriction, including without
|
||||
limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software
|
||||
is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice
|
||||
shall be included in all copies or substantial portions
|
||||
of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
||||
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
|
||||
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
||||
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
|
@ -0,0 +1,138 @@
|
|||
# async-compat
|
||||
|
||||
[![Build](https://github.com/stjepang/async-compat/workflows/Build%20and%20test/badge.svg)](
|
||||
https://github.com/stjepang/async-compat/actions)
|
||||
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](
|
||||
https://github.com/stjepang/async-compat)
|
||||
[![Cargo](https://img.shields.io/crates/v/async-compat.svg)](
|
||||
https://crates.io/crates/async-compat)
|
||||
[![Documentation](https://docs.rs/async-compat/badge.svg)](
|
||||
https://docs.rs/async-compat)
|
||||
|
||||
Compatibility adapter between tokio and futures.
|
||||
|
||||
There are two kinds of compatibility issues between [tokio] and [futures]:
|
||||
|
||||
- Tokio's types cannot be used outside the tokio context. Any attempt to use
|
||||
them will panic. When the `Compat` adapter is applied to a future, it will enter the
|
||||
tokio context.
|
||||
|
||||
- Tokio and futures have similar but different I/O traits `AsyncRead`, `AsyncWrite`,
|
||||
`AsyncBufRead`, and `AsyncSeek`. When the `Compat` adapter is applied to an I/O type, it
|
||||
will implement traits of the opposite kind.
|
||||
|
||||
You can apply the `Compat` adapter using the `Compat::new()` constructor or using any
|
||||
method from the `CompatExt` trait.
|
||||
|
||||
## Examples
|
||||
|
||||
This program reads lines from stdin and echoes them into stdout:
|
||||
|
||||
```rust
|
||||
fn main() -> std::io::Result<()> {
|
||||
futures::executor::block_on(async {
|
||||
let stdin = tokio::io::stdin();
|
||||
let mut stdout = tokio::io::stdout();
|
||||
|
||||
// The following line fails for two reasons:
|
||||
// - Compilation error due mismatched `AsyncRead` and `AsyncWrite` traits.
|
||||
// - Runtime error because stdin and stdout are used outside tokio context.
|
||||
futures::io::copy(stdin, &mut stdout).await?;
|
||||
Ok(())
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
To get around the compatibility issues, apply the `Compat` adapter:
|
||||
|
||||
```rust
|
||||
use async_compat::CompatExt;
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
futures::executor::block_on(async {
|
||||
let stdin = tokio::io::stdin();
|
||||
let mut stdout = tokio::io::stdout();
|
||||
|
||||
futures::io::copy(stdin.compat(), &mut stdout.compat_mut()).compat().await?;
|
||||
Ok(())
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
It is also possible to apply `Compat` to the outer future passed to
|
||||
[`futures::executor::block_on()`] rather than [`futures::io::copy()`] itself:
|
||||
|
||||
```rust
|
||||
use async_compat::{Compat, CompatExt};
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
futures::executor::block_on(Compat::new(async {
|
||||
let stdin = tokio::io::stdin();
|
||||
let mut stdout = tokio::io::stdout();
|
||||
|
||||
futures::io::copy(stdin.compat(), &mut stdout.compat_mut()).await?;
|
||||
Ok(())
|
||||
}))
|
||||
}
|
||||
```
|
||||
|
||||
The compatibility adapter converts between tokio-based and futures-based I/O types in any
|
||||
direction. Here's how we can write the same program by using futures-based I/O types inside
|
||||
tokio:
|
||||
|
||||
```rust
|
||||
use async_compat::CompatExt;
|
||||
use blocking::Unblock;
|
||||
|
||||
#[tokio::main]
|
||||
async fn main() -> std::io::Result<()> {
|
||||
let mut stdin = Unblock::new(std::io::stdin());
|
||||
let mut stdout = Unblock::new(std::io::stdout());
|
||||
|
||||
tokio::io::copy(&mut stdin.compat_mut(), &mut stdout.compat_mut()).await?;
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
Finally, we can use any tokio-based crate from any other async runtime.
|
||||
Here are [reqwest] and [warp] as an example:
|
||||
|
||||
```rust
|
||||
use async_compat::{Compat, CompatExt};
|
||||
use warp::Filter;
|
||||
|
||||
fn main() {
|
||||
futures::executor::block_on(Compat::new(async {
|
||||
// Make an HTTP GET request.
|
||||
let response = reqwest::get("https://www.rust-lang.org").await.unwrap();
|
||||
println!("{}", response.text().await.unwrap());
|
||||
|
||||
// Start an HTTP server.
|
||||
let routes = warp::any().map(|| "Hello from warp!");
|
||||
warp::serve(routes).run(([127, 0, 0, 1], 8080)).await;
|
||||
}))
|
||||
}
|
||||
```
|
||||
|
||||
[blocking]: https://docs.rs/blocking
|
||||
[futures]: https://docs.rs/futures
|
||||
[reqwest]: https://docs.rs/reqwest
|
||||
[tokio]: https://docs.rs/tokio
|
||||
[warp]: https://docs.rs/warp
|
||||
[`futures::io::copy()`]: https://docs.rs/futures/0.3/futures/io/fn.copy.html
|
||||
[`futures::executor::block_on()`]: https://docs.rs/futures/0.3/futures/executor/fn.block_on.html
|
||||
|
||||
## License
|
||||
|
||||
Licensed under either of
|
||||
|
||||
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
||||
|
||||
at your option.
|
||||
|
||||
#### Contribution
|
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||||
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
|
||||
dual licensed as above, without any additional terms or conditions.
|
|
@ -0,0 +1,390 @@
|
|||
//! Compatibility adapter between tokio and futures.
|
||||
//!
|
||||
//! There are two kinds of compatibility issues between [tokio] and [futures]:
|
||||
//!
|
||||
//! - Tokio's types cannot be used outside the tokio context. Any attempt to use
|
||||
//! them will panic. When the [`Compat`] adapter is applied to a future, it will enter the
|
||||
//! tokio context.
|
||||
//!
|
||||
//! - Tokio and futures have similar but different I/O traits `AsyncRead`, `AsyncWrite`,
|
||||
//! `AsyncBufRead`, and `AsyncSeek`. When the [`Compat`] adapter is applied to an I/O type, it
|
||||
//! will implement traits of the opposite kind.
|
||||
//!
|
||||
//! You can apply the [`Compat`] adapter using the [`Compat::new()`] constructor or using any
|
||||
//! method from the [`CompatExt`] trait.
|
||||
//!
|
||||
//! # Examples
|
||||
//!
|
||||
//! This program reads lines from stdin and echoes them into stdout:
|
||||
//!
|
||||
//! ```compile_fail
|
||||
//! fn main() -> std::io::Result<()> {
|
||||
//! futures::executor::block_on(async {
|
||||
//! let stdin = tokio::io::stdin();
|
||||
//! let mut stdout = tokio::io::stdout();
|
||||
//!
|
||||
//! // The following line fails for two reasons:
|
||||
//! // - Compilation error due mismatched `AsyncRead` and `AsyncWrite` traits.
|
||||
//! // - Runtime error because stdin and stdout are used outside tokio context.
|
||||
//! futures::io::copy(stdin, &mut stdout).await?;
|
||||
//! Ok(())
|
||||
//! })
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! To get around the compatibility issues, apply the [`Compat`] adapter:
|
||||
//!
|
||||
//! ```
|
||||
//! use async_compat::CompatExt;
|
||||
//!
|
||||
//! fn main() -> std::io::Result<()> {
|
||||
//! futures::executor::block_on(async {
|
||||
//! let stdin = tokio::io::stdin();
|
||||
//! let mut stdout = tokio::io::stdout();
|
||||
//!
|
||||
//! futures::io::copy(stdin.compat(), &mut stdout.compat_mut()).compat().await?;
|
||||
//! Ok(())
|
||||
//! })
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! It is also possible to apply [`Compat`] to the outer future passed to
|
||||
//! [`futures::executor::block_on()`] rather than [`futures::io::copy()`] itself:
|
||||
//!
|
||||
//! ```no_run
|
||||
//! use async_compat::{Compat, CompatExt};
|
||||
//!
|
||||
//! fn main() -> std::io::Result<()> {
|
||||
//! futures::executor::block_on(Compat::new(async {
|
||||
//! let stdin = tokio::io::stdin();
|
||||
//! let mut stdout = tokio::io::stdout();
|
||||
//!
|
||||
//! futures::io::copy(stdin.compat(), &mut stdout.compat_mut()).await?;
|
||||
//! Ok(())
|
||||
//! }))
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! The compatibility adapter converts between tokio-based and futures-based I/O types in any
|
||||
//! direction. Here's how we can write the same program by using futures-based I/O types inside
|
||||
//! tokio:
|
||||
//!
|
||||
//! ```no_run
|
||||
//! use async_compat::CompatExt;
|
||||
//! use blocking::Unblock;
|
||||
//!
|
||||
//! #[tokio::main]
|
||||
//! async fn main() -> std::io::Result<()> {
|
||||
//! let mut stdin = Unblock::new(std::io::stdin());
|
||||
//! let mut stdout = Unblock::new(std::io::stdout());
|
||||
//!
|
||||
//! tokio::io::copy(&mut stdin.compat_mut(), &mut stdout.compat_mut()).await?;
|
||||
//! Ok(())
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! Finally, we can use any tokio-based crate from any other async runtime.
|
||||
//! Here are [reqwest] and [warp] as an example:
|
||||
//!
|
||||
//! ```no_run
|
||||
//! use async_compat::{Compat, CompatExt};
|
||||
//! use warp::Filter;
|
||||
//!
|
||||
//! fn main() {
|
||||
//! futures::executor::block_on(Compat::new(async {
|
||||
//! // Make an HTTP GET request.
|
||||
//! let response = reqwest::get("https://www.rust-lang.org").await.unwrap();
|
||||
//! println!("{}", response.text().await.unwrap());
|
||||
//!
|
||||
//! // Start an HTTP server.
|
||||
//! let routes = warp::any().map(|| "Hello from warp!");
|
||||
//! warp::serve(routes).run(([127, 0, 0, 1], 8080)).await;
|
||||
//! }))
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! [blocking]: https://docs.rs/blocking
|
||||
//! [futures]: https://docs.rs/futures
|
||||
//! [reqwest]: https://docs.rs/reqwest
|
||||
//! [tokio]: https://docs.rs/tokio
|
||||
//! [warp]: https://docs.rs/warp
|
||||
//! [`futures::io::copy()`]: https://docs.rs/futures/0.3/futures/io/fn.copy.html
|
||||
//! [`futures::executor::block_on()`]: https://docs.rs/futures/0.3/futures/executor/fn.block_on.html
|
||||
|
||||
use std::future::Future;
|
||||
use std::io;
|
||||
use std::pin::Pin;
|
||||
use std::task::{Context, Poll};
|
||||
use std::thread;
|
||||
|
||||
use futures_core::ready;
|
||||
use once_cell::sync::Lazy;
|
||||
use pin_project_lite::pin_project;
|
||||
|
||||
/// Applies the [`Compat`] adapter to futures and I/O types.
|
||||
pub trait CompatExt {
|
||||
/// Applies the [`Compat`] adapter by value.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_compat::CompatExt;
|
||||
///
|
||||
/// let stdout = tokio::io::stdout().compat();
|
||||
/// ```
|
||||
fn compat(self) -> Compat<Self>
|
||||
where
|
||||
Self: Sized;
|
||||
|
||||
/// Applies the [`Compat`] adapter by shared reference.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_compat::CompatExt;
|
||||
///
|
||||
/// let original = tokio::io::stdout();
|
||||
/// let stdout = original.compat_ref();
|
||||
/// ```
|
||||
fn compat_ref(&self) -> Compat<&Self>;
|
||||
|
||||
/// Applies the [`Compat`] adapter by mutable reference.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_compat::CompatExt;
|
||||
///
|
||||
/// let mut original = tokio::io::stdout();
|
||||
/// let stdout = original.compat_mut();
|
||||
/// ```
|
||||
fn compat_mut(&mut self) -> Compat<&mut Self>;
|
||||
}
|
||||
|
||||
impl<T> CompatExt for T {
|
||||
fn compat(self) -> Compat<Self>
|
||||
where
|
||||
Self: Sized,
|
||||
{
|
||||
Compat::new(self)
|
||||
}
|
||||
|
||||
fn compat_ref(&self) -> Compat<&Self> {
|
||||
Compat::new(self)
|
||||
}
|
||||
|
||||
fn compat_mut(&mut self) -> Compat<&mut Self> {
|
||||
Compat::new(self)
|
||||
}
|
||||
}
|
||||
|
||||
pin_project! {
|
||||
/// Compatibility adapter for futures and I/O types.
|
||||
pub struct Compat<T> {
|
||||
#[pin]
|
||||
inner: T,
|
||||
seek_pos: Option<io::SeekFrom>,
|
||||
seek_res: Option<io::Result<u64>>,
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Compat<T> {
|
||||
/// Applies the compatibility adapter to a future or an I/O type.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Apply it to a future:
|
||||
///
|
||||
/// ```
|
||||
/// use async_compat::Compat;
|
||||
/// use std::time::Duration;
|
||||
/// use tokio::time::delay_for;
|
||||
///
|
||||
/// futures::executor::block_on(Compat::new(async {
|
||||
/// // We can use tokio's timers because we're inside tokio context.
|
||||
/// tokio::time::delay_for(Duration::from_secs(1)).await;
|
||||
/// }));
|
||||
/// ```
|
||||
///
|
||||
/// Apply it to an I/O type:
|
||||
///
|
||||
/// ```
|
||||
/// use async_compat::{Compat, CompatExt};
|
||||
/// use futures::prelude::*;
|
||||
///
|
||||
/// # fn main() -> std::io::Result<()> {
|
||||
/// futures::executor::block_on(Compat::new(async {
|
||||
/// // The `write_all` method comes from `futures::io::AsyncWriteExt`.
|
||||
/// Compat::new(tokio::io::stdout()).write_all(b"hello\n").await?;
|
||||
/// Ok(())
|
||||
/// }))
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn new(t: T) -> Compat<T> {
|
||||
Compat {
|
||||
inner: t,
|
||||
seek_pos: None,
|
||||
seek_res: None,
|
||||
}
|
||||
}
|
||||
|
||||
/// Unwraps the compatibility adapter.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_compat::Compat;
|
||||
///
|
||||
/// let stdout = Compat::new(tokio::io::stdout());
|
||||
/// let original = stdout.into_inner();
|
||||
/// ```
|
||||
pub fn into_inner(self) -> T {
|
||||
self.inner
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Future> Future for Compat<T> {
|
||||
type Output = T::Output;
|
||||
|
||||
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||
TOKIO.enter(|| self.project().inner.poll(cx))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: tokio::io::AsyncRead> futures_io::AsyncRead for Compat<T> {
|
||||
fn poll_read(
|
||||
self: Pin<&mut Self>,
|
||||
cx: &mut Context<'_>,
|
||||
buf: &mut [u8],
|
||||
) -> Poll<io::Result<usize>> {
|
||||
self.project().inner.poll_read(cx, buf)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: futures_io::AsyncRead> tokio::io::AsyncRead for Compat<T> {
|
||||
fn poll_read(
|
||||
self: Pin<&mut Self>,
|
||||
cx: &mut Context<'_>,
|
||||
buf: &mut [u8],
|
||||
) -> Poll<io::Result<usize>> {
|
||||
self.project().inner.poll_read(cx, buf)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: tokio::io::AsyncBufRead> futures_io::AsyncBufRead for Compat<T> {
|
||||
fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&[u8]>> {
|
||||
self.project().inner.poll_fill_buf(cx)
|
||||
}
|
||||
|
||||
fn consume(self: Pin<&mut Self>, amt: usize) {
|
||||
self.project().inner.consume(amt)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: futures_io::AsyncBufRead> tokio::io::AsyncBufRead for Compat<T> {
|
||||
fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&[u8]>> {
|
||||
self.project().inner.poll_fill_buf(cx)
|
||||
}
|
||||
|
||||
fn consume(self: Pin<&mut Self>, amt: usize) {
|
||||
self.project().inner.consume(amt)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: tokio::io::AsyncWrite> futures_io::AsyncWrite for Compat<T> {
|
||||
fn poll_write(
|
||||
self: Pin<&mut Self>,
|
||||
cx: &mut Context<'_>,
|
||||
buf: &[u8],
|
||||
) -> Poll<io::Result<usize>> {
|
||||
self.project().inner.poll_write(cx, buf)
|
||||
}
|
||||
|
||||
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
|
||||
self.project().inner.poll_flush(cx)
|
||||
}
|
||||
|
||||
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
|
||||
self.project().inner.poll_shutdown(cx)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: futures_io::AsyncWrite> tokio::io::AsyncWrite for Compat<T> {
|
||||
fn poll_write(
|
||||
self: Pin<&mut Self>,
|
||||
cx: &mut Context<'_>,
|
||||
buf: &[u8],
|
||||
) -> Poll<io::Result<usize>> {
|
||||
self.project().inner.poll_write(cx, buf)
|
||||
}
|
||||
|
||||
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
|
||||
self.project().inner.poll_flush(cx)
|
||||
}
|
||||
|
||||
fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
|
||||
self.project().inner.poll_close(cx)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: tokio::io::AsyncSeek> futures_io::AsyncSeek for Compat<T> {
|
||||
fn poll_seek(
|
||||
mut self: Pin<&mut Self>,
|
||||
cx: &mut Context,
|
||||
pos: io::SeekFrom,
|
||||
) -> Poll<io::Result<u64>> {
|
||||
if self.seek_pos != Some(pos) {
|
||||
ready!(self.as_mut().project().inner.start_seek(cx, pos))?;
|
||||
*self.as_mut().project().seek_pos = Some(pos);
|
||||
}
|
||||
let res = ready!(self.as_mut().project().inner.poll_complete(cx));
|
||||
*self.as_mut().project().seek_pos = None;
|
||||
Poll::Ready(res.map(|p| p as u64))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: futures_io::AsyncSeek> tokio::io::AsyncSeek for Compat<T> {
|
||||
fn start_seek(
|
||||
mut self: Pin<&mut Self>,
|
||||
cx: &mut Context,
|
||||
pos: io::SeekFrom,
|
||||
) -> Poll<io::Result<()>> {
|
||||
let p = ready!(self.as_mut().project().inner.poll_seek(cx, pos))?;
|
||||
*self.project().seek_res = Some(Ok(p));
|
||||
Poll::Ready(Ok(()))
|
||||
}
|
||||
|
||||
fn poll_complete(self: Pin<&mut Self>, _: &mut Context) -> Poll<io::Result<u64>> {
|
||||
Poll::Ready(
|
||||
self.project()
|
||||
.seek_res
|
||||
.take()
|
||||
.unwrap_or(Err(io::ErrorKind::Other.into())),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
static TOKIO: Lazy<tokio::runtime::Handle> = Lazy::new(|| {
|
||||
let mut rt = tokio::runtime::Builder::new()
|
||||
.enable_all()
|
||||
.basic_scheduler()
|
||||
.build()
|
||||
.expect("cannot start tokio runtime");
|
||||
|
||||
let handle = rt.handle().clone();
|
||||
thread::Builder::new()
|
||||
.name("async-compat/tokio".to_string())
|
||||
.spawn(move || rt.block_on(Pending))
|
||||
.unwrap();
|
||||
handle
|
||||
});
|
||||
|
||||
struct Pending;
|
||||
|
||||
impl Future for Pending {
|
||||
type Output = ();
|
||||
|
||||
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Self::Output> {
|
||||
Poll::Pending
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue