Initial commit
This commit is contained in:
commit
e41f34cc00
|
@ -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.1
|
||||
|
||||
- Initial version
|
|
@ -0,0 +1,32 @@
|
|||
[package]
|
||||
name = "async-executor"
|
||||
version = "0.1.0"
|
||||
authors = ["Stjepan Glavina <stjepang@gmail.com>"]
|
||||
edition = "2018"
|
||||
description = "Async executor"
|
||||
license = "Apache-2.0 OR MIT"
|
||||
repository = "https://github.com/stjepang/async-executor"
|
||||
homepage = "https://github.com/stjepang/async-executor"
|
||||
documentation = "https://docs.rs/async-executor"
|
||||
keywords = ["asynchronous", "executor", "single", "multi", "spawn"]
|
||||
categories = ["asynchronous", "concurrency"]
|
||||
readme = "README.md"
|
||||
|
||||
[features]
|
||||
default = ["async-io"]
|
||||
|
||||
[dependencies]
|
||||
futures-lite = "0.1.8"
|
||||
multitask = "0.2.0"
|
||||
parking = "1.0.5"
|
||||
scoped-tls = "1.0.0"
|
||||
waker-fn = "1.0.0"
|
||||
|
||||
# Optional optimization: executor waits on I/O when idle.
|
||||
[dependencies.async-io]
|
||||
version = "0.1.5"
|
||||
optional = true
|
||||
|
||||
[dev-dependencies]
|
||||
async-channel = "1.1.1"
|
||||
easy-parallel = "3.1.0"
|
|
@ -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,52 @@
|
|||
# async-executor
|
||||
|
||||
[![Build](https://github.com/stjepang/async-executor/workflows/Build%20and%20test/badge.svg)](
|
||||
https://github.com/stjepang/async-executor/actions)
|
||||
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](
|
||||
https://github.com/stjepang/async-executor)
|
||||
[![Cargo](https://img.shields.io/crates/v/async-executor.svg)](
|
||||
https://crates.io/crates/async-executor)
|
||||
[![Documentation](https://docs.rs/async-executor/badge.svg)](
|
||||
https://docs.rs/async-executor)
|
||||
|
||||
Async executor.
|
||||
|
||||
This crate offers two kinds of executors: single-threaded and multi-threaded.
|
||||
|
||||
## Examples
|
||||
|
||||
Run a single-threaded and a multi-threaded executor at the same time:
|
||||
|
||||
```rust
|
||||
use async_channel::unbounded;
|
||||
use async_executor::{Executor, LocalExecutor};
|
||||
use easy_parallel::Parallel;
|
||||
|
||||
let ex = Executor::new();
|
||||
let local_ex = LocalExecutor::new();
|
||||
let (trigger, shutdown) = unbounded::<()>();
|
||||
|
||||
Parallel::new()
|
||||
// Run four executor threads.
|
||||
.each(0..4, |_| ex.run(shutdown.recv()))
|
||||
// Run local executor on the current thread.
|
||||
.finish(|| local_ex.run(async {
|
||||
println!("Hello world!");
|
||||
drop(trigger);
|
||||
}));
|
||||
```
|
||||
|
||||
## 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 @@
|
|||
version = "Two"
|
|
@ -0,0 +1,452 @@
|
|||
//! Async executor.
|
||||
//!
|
||||
//! This crate offers two kinds of executors: single-threaded and multi-threaded.
|
||||
//!
|
||||
//! # Examples
|
||||
//!
|
||||
//! Run a single-threaded and a multi-threaded executor at the same time:
|
||||
//!
|
||||
//! ```
|
||||
//! use async_channel::unbounded;
|
||||
//! use async_executor::{Executor, LocalExecutor};
|
||||
//! use easy_parallel::Parallel;
|
||||
//!
|
||||
//! let ex = Executor::new();
|
||||
//! let local_ex = LocalExecutor::new();
|
||||
//! let (trigger, shutdown) = unbounded::<()>();
|
||||
//!
|
||||
//! Parallel::new()
|
||||
//! // Run four executor threads.
|
||||
//! .each(0..4, |_| ex.run(shutdown.recv()))
|
||||
//! // Run local executor on the current thread.
|
||||
//! .finish(|| local_ex.run(async {
|
||||
//! println!("Hello world!");
|
||||
//! drop(trigger);
|
||||
//! }));
|
||||
//! ```
|
||||
|
||||
#![forbid(unsafe_code)]
|
||||
#![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]
|
||||
|
||||
use std::future::Future;
|
||||
use std::pin::Pin;
|
||||
use std::task::{Context, Poll};
|
||||
use std::time::Duration;
|
||||
|
||||
use futures_lite::pin;
|
||||
use scoped_tls::scoped_thread_local;
|
||||
use waker_fn::waker_fn;
|
||||
|
||||
#[cfg(feature = "async-io")]
|
||||
use async_io::parking;
|
||||
#[cfg(not(feature = "async-io"))]
|
||||
use parking;
|
||||
|
||||
scoped_thread_local!(static EX: Executor);
|
||||
scoped_thread_local!(static LOCAL_EX: LocalExecutor);
|
||||
|
||||
/// Multi-threaded executor.
|
||||
///
|
||||
/// The executor does not spawn threads on its own. Instead, you need to call [`Executor::run()`]
|
||||
/// on manually spawned executor threads.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_channel::unbounded;
|
||||
/// use async_executor::Executor;
|
||||
/// use easy_parallel::Parallel;
|
||||
/// use futures_lite::future;
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
/// let (signal, shutdown) = unbounded::<()>();
|
||||
///
|
||||
/// Parallel::new()
|
||||
/// // Run four executor threads.
|
||||
/// .each(0..4, |_| ex.run(shutdown.recv()))
|
||||
/// // Run the main future on the current thread.
|
||||
/// .finish(|| future::block_on(async {
|
||||
/// println!("Hello world!");
|
||||
/// drop(signal);
|
||||
/// }));
|
||||
/// ```
|
||||
#[derive(Debug)]
|
||||
pub struct Executor {
|
||||
ex: multitask::Executor,
|
||||
}
|
||||
|
||||
impl Executor {
|
||||
/// Creates a multi-threaded executor.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::LocalExecutor;
|
||||
///
|
||||
/// let local_ex = LocalExecutor::new();
|
||||
/// ```
|
||||
pub fn new() -> Executor {
|
||||
Executor {
|
||||
ex: multitask::Executor::new(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Spawns a task onto the executor.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::Executor;
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
///
|
||||
/// let task = ex.spawn(async {
|
||||
/// println!("Hello world");
|
||||
/// });
|
||||
/// ```
|
||||
pub fn spawn<T: Send + 'static>(
|
||||
&self,
|
||||
future: impl Future<Output = T> + Send + 'static,
|
||||
) -> Task<T> {
|
||||
Task(self.ex.spawn(future))
|
||||
}
|
||||
|
||||
/// Enters the context of an executor.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::{Executor, Task};
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
///
|
||||
/// ex.enter(|| {
|
||||
/// // `Task::spawn()` now knows which executor to spawn onto.
|
||||
/// let task = Task::spawn(async {
|
||||
/// println!("Hello world");
|
||||
/// });
|
||||
/// });
|
||||
/// ```
|
||||
pub fn enter<T>(&self, f: impl FnOnce() -> T) -> T {
|
||||
if EX.is_set() {
|
||||
panic!("cannot call `Executor::enter()` if already inside an `Executor`");
|
||||
}
|
||||
EX.set(self, f)
|
||||
}
|
||||
|
||||
/// Runs the executor until the given future completes.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::Executor;
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
///
|
||||
/// let task = ex.spawn(async { 1 + 2 });
|
||||
/// let res = ex.run(async { task.await * 2 });
|
||||
///
|
||||
/// assert_eq!(res, 6);
|
||||
/// ```
|
||||
pub fn run<T>(&self, future: impl Future<Output = T>) -> T {
|
||||
self.enter(|| {
|
||||
let (p, u) = parking::pair();
|
||||
|
||||
let ticker = self.ex.ticker({
|
||||
let u = u.clone();
|
||||
move || u.unpark()
|
||||
});
|
||||
|
||||
pin!(future);
|
||||
let waker = waker_fn(move || u.unpark());
|
||||
let cx = &mut Context::from_waker(&waker);
|
||||
|
||||
'start: loop {
|
||||
if let Poll::Ready(t) = future.as_mut().poll(cx) {
|
||||
break t;
|
||||
}
|
||||
|
||||
for _ in 0..200 {
|
||||
if !ticker.tick() {
|
||||
p.park();
|
||||
continue 'start;
|
||||
}
|
||||
}
|
||||
p.park_timeout(Duration::from_secs(0));
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for Executor {
|
||||
fn default() -> Executor {
|
||||
Executor::new()
|
||||
}
|
||||
}
|
||||
|
||||
/// Single-threaded executor.
|
||||
///
|
||||
/// The executor can only be run on the thread that created it.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::LocalExecutor;
|
||||
///
|
||||
/// let local_ex = LocalExecutor::new();
|
||||
///
|
||||
/// local_ex.run(async {
|
||||
/// println!("Hello world!");
|
||||
/// });
|
||||
/// ```
|
||||
#[derive(Debug)]
|
||||
pub struct LocalExecutor {
|
||||
ex: multitask::LocalExecutor,
|
||||
parker: parking::Parker,
|
||||
}
|
||||
|
||||
impl LocalExecutor {
|
||||
/// Creates a single-threaded executor.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::LocalExecutor;
|
||||
///
|
||||
/// let local_ex = LocalExecutor::new();
|
||||
/// ```
|
||||
pub fn new() -> LocalExecutor {
|
||||
let (p, u) = parking::pair();
|
||||
LocalExecutor {
|
||||
ex: multitask::LocalExecutor::new(move || u.unpark()),
|
||||
parker: p,
|
||||
}
|
||||
}
|
||||
|
||||
/// Spawns a task onto the executor.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::LocalExecutor;
|
||||
///
|
||||
/// let local_ex = LocalExecutor::new();
|
||||
///
|
||||
/// let task = local_ex.spawn(async {
|
||||
/// println!("Hello world");
|
||||
/// });
|
||||
/// ```
|
||||
pub fn spawn<T: 'static>(&self, future: impl Future<Output = T> + 'static) -> Task<T> {
|
||||
Task(self.ex.spawn(future))
|
||||
}
|
||||
|
||||
/// Runs the executor until the given future completes.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::LocalExecutor;
|
||||
///
|
||||
/// let local_ex = LocalExecutor::new();
|
||||
///
|
||||
/// let task = local_ex.spawn(async { 1 + 2 });
|
||||
/// let res = local_ex.run(async { task.await * 2 });
|
||||
///
|
||||
/// assert_eq!(res, 6);
|
||||
/// ```
|
||||
pub fn run<T>(&self, future: impl Future<Output = T>) -> T {
|
||||
pin!(future);
|
||||
|
||||
let u = self.parker.unparker();
|
||||
let waker = waker_fn(move || u.unpark());
|
||||
let cx = &mut Context::from_waker(&waker);
|
||||
|
||||
LOCAL_EX.set(self, || {
|
||||
'start: loop {
|
||||
if let Poll::Ready(t) = future.as_mut().poll(cx) {
|
||||
break t;
|
||||
}
|
||||
|
||||
for _ in 0..200 {
|
||||
if !self.ex.tick() {
|
||||
self.parker.park();
|
||||
continue 'start;
|
||||
}
|
||||
}
|
||||
self.parker.park_timeout(Duration::from_secs(0));
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for LocalExecutor {
|
||||
fn default() -> LocalExecutor {
|
||||
LocalExecutor::new()
|
||||
}
|
||||
}
|
||||
|
||||
/// A spawned future.
|
||||
///
|
||||
/// Tasks are also futures themselves and yield the output of the spawned future.
|
||||
///
|
||||
/// When a task is dropped, its gets canceled and won't be polled again. To cancel a task a bit
|
||||
/// more gracefully and wait until it stops running, use the [`cancel()`][`Task::cancel()`] method.
|
||||
///
|
||||
/// Tasks that panic get immediately canceled. Awaiting a canceled task also causes a panic.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::{Executor, Task};
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
///
|
||||
/// ex.run(async {
|
||||
/// let task = Task::spawn(async {
|
||||
/// println!("Hello from a task!");
|
||||
/// 1 + 2
|
||||
/// });
|
||||
///
|
||||
/// assert_eq!(task.await, 3);
|
||||
/// });
|
||||
/// ```
|
||||
#[must_use = "tasks get canceled when dropped, use `.detach()` to run them in the background"]
|
||||
#[derive(Debug)]
|
||||
pub struct Task<T>(multitask::Task<T>);
|
||||
|
||||
impl<T> Task<T> {
|
||||
/// Spawns a task onto the current multi-threaded or single-threaded executor.
|
||||
///
|
||||
/// If called from an [`Executor`] (preferred) or from a [`LocalExecutor`], the task is spawned
|
||||
/// on it.
|
||||
///
|
||||
/// Otherwise, this method panics.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::{Executor, Task};
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
///
|
||||
/// ex.run(async {
|
||||
/// let task = Task::spawn(async { 1 + 2 });
|
||||
/// assert_eq!(task.await, 3);
|
||||
/// });
|
||||
/// ```
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::{LocalExecutor, Task};
|
||||
///
|
||||
/// let local_ex = LocalExecutor::new();
|
||||
///
|
||||
/// local_ex.run(async {
|
||||
/// let task = Task::spawn(async { 1 + 2 });
|
||||
/// assert_eq!(task.await, 3);
|
||||
/// });
|
||||
/// ```
|
||||
pub fn spawn(future: impl Future<Output = T> + Send + 'static) -> Task<T>
|
||||
where
|
||||
T: Send + 'static,
|
||||
{
|
||||
if EX.is_set() {
|
||||
EX.with(|ex| ex.spawn(future))
|
||||
} else if LOCAL_EX.is_set() {
|
||||
LOCAL_EX.with(|local_ex| local_ex.spawn(future))
|
||||
} else {
|
||||
panic!("`Task::spawn()` must be called from an `Executor` or `LocalExecutor`")
|
||||
}
|
||||
}
|
||||
|
||||
/// Spawns a task onto the current single-threaded executor.
|
||||
///
|
||||
/// If called from a [`LocalExecutor`], the task is spawned on it.
|
||||
///
|
||||
/// Otherwise, this method panics.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::{LocalExecutor, Task};
|
||||
///
|
||||
/// let local_ex = LocalExecutor::new();
|
||||
///
|
||||
/// local_ex.run(async {
|
||||
/// let task = Task::local(async { 1 + 2 });
|
||||
/// assert_eq!(task.await, 3);
|
||||
/// });
|
||||
/// ```
|
||||
pub fn local(future: impl Future<Output = T> + 'static) -> Task<T>
|
||||
where
|
||||
T: 'static,
|
||||
{
|
||||
if LOCAL_EX.is_set() {
|
||||
LOCAL_EX.with(|local_ex| local_ex.spawn(future))
|
||||
} else {
|
||||
panic!("`Task::local()` must be called from a `LocalExecutor`")
|
||||
}
|
||||
}
|
||||
|
||||
/// Detaches the task to let it keep running in the background.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::{Executor, Task};
|
||||
/// use futures_lite::future;
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
///
|
||||
/// ex.spawn(async {
|
||||
/// loop {
|
||||
/// println!("I'm a background task looping forever.");
|
||||
/// future::yield_now().await;
|
||||
/// }
|
||||
/// })
|
||||
/// .detach();
|
||||
///
|
||||
/// ex.run(future::yield_now());
|
||||
/// ```
|
||||
pub fn detach(self) {
|
||||
self.0.detach();
|
||||
}
|
||||
|
||||
/// Cancels the task and waits for it to stop running.
|
||||
///
|
||||
/// Returns the task's output if it was completed just before it got canceled, or [`None`] if
|
||||
/// it didn't complete.
|
||||
///
|
||||
/// While it's possible to simply drop the [`Task`] to cancel it, this is a cleaner way of
|
||||
/// canceling because it also waits for the task to stop running.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use async_executor::{Executor, Task};
|
||||
/// use futures_lite::future;
|
||||
///
|
||||
/// let ex = Executor::new();
|
||||
///
|
||||
/// let task = ex.spawn(async {
|
||||
/// loop {
|
||||
/// println!("Even though I'm in an infinite loop, you can still cancel me!");
|
||||
/// future::yield_now().await;
|
||||
/// }
|
||||
/// });
|
||||
///
|
||||
/// ex.run(async {
|
||||
/// task.cancel().await;
|
||||
/// });
|
||||
/// ```
|
||||
pub async fn cancel(self) -> Option<T> {
|
||||
self.0.cancel().await
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Future for Task<T> {
|
||||
type Output = T;
|
||||
|
||||
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||
Pin::new(&mut self.0).poll(cx)
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue