Rust-Poll promise: A Rust promise for games and immediate mode GUIs

poll-promise

A Rust promise for games and immediate mode GUIs

Embark Embark Crates.io Docs dependency status Build status

Description

poll-promise is a Rust crate for polling the result of a concurrent (e.g. async) operation. This is in particular useful in games and immediate mode GUI:s, where one often wants to start a background operation and then ask "are we there yet?" on each subsequent frame until the operation completes.

Example:

let promise = poll_promise::Promise::spawn_thread("slow_operation", something_slow);

// Then in the game loop or immediate mode GUI code:
if let Some(result) = promise.ready() {
    // Use/show result
} else {
    // Show a loading icon
}

If you enable the tokio feature you can use poll-promise with the tokio runtime.

Caveat

The crate is primarily useful as a high-level building block in apps.

This crate provides convenience methods to spawn threads and tokio tasks, and methods that block on waiting for a result. This is gererally a bad idea to do in a library, as decisions about execution environments and thread blocking should be left to the app. So we do not recommend using this crate for libraries in its current state.

Contribution

Contributor Covenant

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started. Please also read our Contributor Terms before you make any contributions.

Any contribution intentionally submitted for inclusion in an Embark Studios project, shall comply with the Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed as described below, without any additional terms or conditions:

License

This contribution is dual licensed under EITHER OF

at your option.

For clarity, "your" refers to Embark or any other licensee/user of the contribution.

Comments

  • Show feature labels in generated docs
    Show feature labels in generated docs

    Jan 11, 2022

    Checklist

    • [x] I have read the Contributor Guide
    • [x] I have read and agree to the Code of Conduct
    • [x] I have added a description of my changes and why I'd like them included in the section below

    Description of Changes

    Adds #[cfg_attr(docsrs, doc(cfg(any(feature = "..."))))] to required features are highlighted in the standard rustdoc way.

    Before: Screen Shot 2022-01-11 at 09 58 55

    After: Screen Shot 2022-01-11 at 10 08 01

    Related Issues

    None.

    documentation 
    Reply
  • Add Promise::abort
    Add Promise::abort

    Jan 13, 2022

    Add method to abort the running tokio task, if any.

    Reply
  • Run CI
    Run CI

    Jan 10, 2022

    Checklist

    • [x] I have read the Contributor Guide
    • [x] I have read and agree to the Code of Conduct
    • [x] I have added a description of my changes and why I'd like them included in the section below

    Description of Changes

    Turn on the CI. It is more useful that way.

    Reply
  • Add 'web' feature to spawn tasks using wasm_bndget_futures::spawn_local
    Add 'web' feature to spawn tasks using wasm_bndget_futures::spawn_local

    Jan 10, 2022

    Checklist

    • [x] I have read the Contributor Guide
    • [x] I have read and agree to the Code of Conduct
    • [x] I have added a description of my changes and why I'd like them included in the section below

    Description of Changes

    This enables spawn_async ~and spawn_blocking~ when compiling for web.

    Related Issues

    Reply