2020-07-23 10:03:03 +00:00
|
|
|
# async-executor
|
|
|
|
|
2020-12-26 14:47:13 +00:00
|
|
|
[![Build](https://github.com/smol-rs/async-executor/workflows/Build%20and%20test/badge.svg)](
|
|
|
|
https://github.com/smol-rs/async-executor/actions)
|
2021-02-14 04:39:05 +00:00
|
|
|
[![License](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)](
|
2020-12-26 14:47:13 +00:00
|
|
|
https://github.com/smol-rs/async-executor)
|
2020-07-23 10:03:03 +00:00
|
|
|
[![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)
|
|
|
|
|
2020-08-26 21:46:09 +00:00
|
|
|
Async executors.
|
2020-07-23 10:03:03 +00:00
|
|
|
|
2023-11-11 16:34:46 +00:00
|
|
|
This crate provides two reference executors that trade performance for
|
|
|
|
functionality. They should be considered reference executors that are "good
|
|
|
|
enough" for most use cases. For more specialized use cases, consider writing
|
|
|
|
your own executor on top of [`async-task`].
|
|
|
|
|
|
|
|
[`async-task`]: https://crates.io/crates/async-task
|
|
|
|
|
2020-07-23 10:03:03 +00:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
```rust
|
2020-08-26 21:46:09 +00:00
|
|
|
use async_executor::Executor;
|
|
|
|
use futures_lite::future;
|
2020-07-23 10:03:03 +00:00
|
|
|
|
2020-08-26 21:46:09 +00:00
|
|
|
// Create a new executor.
|
2020-07-23 10:03:03 +00:00
|
|
|
let ex = Executor::new();
|
2020-08-26 21:46:09 +00:00
|
|
|
|
|
|
|
// Spawn a task.
|
|
|
|
let task = ex.spawn(async {
|
|
|
|
println!("Hello world");
|
|
|
|
});
|
|
|
|
|
2020-12-08 18:48:57 +00:00
|
|
|
// Run the executor until the task completes.
|
2020-08-26 21:46:09 +00:00
|
|
|
future::block_on(ex.run(task));
|
2020-07-23 10:03:03 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## 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.
|