Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loopystudios/bevy_async_task
Cross-platform ergonomic abstractions for async programming in Bevy.
https://github.com/loopystudios/bevy_async_task
async bevy bevy-engine rust
Last synced: 2 days ago
JSON representation
Cross-platform ergonomic abstractions for async programming in Bevy.
- Host: GitHub
- URL: https://github.com/loopystudios/bevy_async_task
- Owner: loopystudios
- License: apache-2.0
- Created: 2023-06-03T14:46:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-02T17:04:02.000Z (21 days ago)
- Last Synced: 2024-12-14T04:07:15.159Z (9 days ago)
- Topics: async, bevy, bevy-engine, rust
- Language: Rust
- Homepage: https://crates.io/crates/bevy_async_task
- Size: 94.7 KB
- Stars: 69
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Bevy Async Task
[](https://discord.gg/zrjnQzdjCB)
[](https://github.com/loopystudios/bevy_async_task/actions)
[](https://deps.rs/repo/github/loopystudios/bevy_async_task)
[](https://crates.io/crates/bevy_async_task)
[](https://docs.rs/bevy_async_task)
A minimum crate for ergonomic abstractions to async programming in Bevy. There is full API support for **wasm** and **native**. Android and iOS are untested (Help needed).
Bevy Async Task provides Bevy system parameters to run asynchronous tasks in the background on web and native with timeouts and output capture.
## Bevy version support
|bevy|bevy_async_task|
|---|---|
|0.15|0.3-0.4, main|
|0.14|0.2|
|0.13|0.1|
|<= 0.13|Unsupported|
## Usage
There are several [examples](examples/) for reference.
You can also run examples on web:
```shell
# Make sure the Rust toolchain supports the wasm32 target
rustup target add wasm32-unknown-unknown
cargo run_wasm --example simple
```
### Polling in systems
Poll one task at a time with `AsyncTaskRunner`:
```rust
async fn long_task() -> u32 {
sleep(Duration::from_millis(1000)).await;
5
}
fn my_system(mut task_runner: AsyncTaskRunner) {
if task_runner.is_idle() {
task_executor.start(long_task());
info!("Started!");
}
match task_runner.poll() {
Poll::Ready(v) => {
info!("Received {v:?}");
}
Poll::Pending => {
// Waiting...
}
}
}
```
Poll many similar tasks simultaneously with `AsyncTaskPool`:
```rust
fn my_system(mut task_pool: AsyncTaskPool) {
if task_pool.is_idle() {
info!("Queueing 5 tasks...");
for i in 1..=5 {
task_pool.spawn(async move { // Closures work too!
sleep(Duration::from_millis(i * 1000)).await;
i
});
}
}
for status in task_pool.iter_poll() {
if let Poll::Ready(v) = status {
info!("Received {v:?}");
}
}
}
```
We also have a [`cross_system` example](./examples/cross_system.rs).
## Community
All Loopy projects and development happens in the [Loopy Discord](https://discord.gg/zrjnQzdjCB). The discord is open to the public.
Contributions are welcome by pull request. The [Rust code of conduct](https://www.rust-lang.org/policies/code-of-conduct) applies.
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license
([LICENSE-MIT](LICENSE-MIT) or )
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.