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

Mutating through a shared reference without an UnsafeCell is UB. From the UnsafeCell docs:

If you have a reference &T, then normally in Rust the compiler performs optimizations based on the knowledge that &T points to immutable data. Mutating that data, for example through an alias or by transmuting an &T into an &mut T, is considered undefined behavior.

unsafe {
      let myself = self as *const Self as *mut Self;
      *myself = Self::Ready(value);
}

^ is thus UB

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

Smol is now a supported executor. With it comes two new functions:

// Ticks the smol thread executor
poll_promise::tick();
// Ticks the thread local smol executor
poll_promise::tick_local();

They should be used in an update loop when not using the tick-poll feature.

loop {
  // game logic code here

  // push a frame

  // tick executor
  poll_promise::tick();
}

• These tick static variables provided by the crate EXECUTOR and LOCAL_EXECUTOR resepectively
• Blocking on promises now loops and constantly polls them instead of waiting on the receiver
• Blocking also automatically ticks for you
• The tick-poll feature automatically ticks the executors when polling promises like when blocking

Promises now have a field called task_type which stores the type of task the promise is running (TaskType::Local for local tasks, TaskType::Async for async tasks, etc) They are used primarily for determining what executor to tick when blocking (or polling)

There are now tests in lib.rs

    fn it_spawns_threads() {
        let promise = Promise::spawn_thread("test", || {
            std::thread::sleep(std::time::Duration::from_secs(1));
            0
        });

        assert_eq!(0, promise.block_and_take());
    }

• Promise::spawn_async has been split into Promise::spawn_local to run futures locally
• Promise::spawn_async is no longer usable on wasm and spawn_local must be used instead

Tokio does not play very well with spawn_local though, there doesn't seem to be much this library could do about that without forcing a Send bound onto spawn_local

Related Issues

Helps further resolve #8 and makes poll_promise more usable on the web and on native

The version published to crates.io doesn't have the web feature, so you can't use poll-promise in WASM unless you directly add the Git repository as a dependency.

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

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

Prepare for 0.1.1 release

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

Fix cargo deny check problem seen in https://github.com/EmbarkStudios/poll-promise/pull/9

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

Added attributes in the function parameters for Promise::spawn_async to enable/disable the Send trait bound

Without this patch calling an async function like this one using poll promise would not compile

#[wasm_bindgen(module = "/assets/filesystem.js")]
extern "C" {
    #[wasm_bindgen(catch)]
    async fn js_open_project() -> Result<JsValue, JsValue>;
    #[wasm_bindgen(catch)]
    async fn js_read_file(handle: JsValue, _path: String) -> Result<JsValue, JsValue>;
    fn js_filesystem_supported() -> bool;
}

/* ... */

pub async fn try_open_project(&self, cache: Arc<DataCache>) -> Result<(), String> {
    let handle = js_open_project()
        .await
        .map_err(|_| "No project loaded".to_string())?;

    self.load_project(handle, cache)
}

It'd make sense to remove the Send limitation specifically for web since I'd imagine people using this crate for wasm are likely operating with async JS functions

https://github.com/Speak2Erase/poll-promise/blob/bfc32879452afea0f2eec6355e40ec4de05c8c92/src/promise.rs#L112-L113

Related Issues

Fixes #8

https://github.com/EmbarkStudios/poll-promise/blob/089c99062e289808b8077457f84b01f5c347aa28/src/promise.rs#L108

From what I understand Send on this line is not necessary with wasm futures since the spawn_local does not require that trait. https://github.com/EmbarkStudios/poll-promise/blob/089c99062e289808b8077457f84b01f5c347aa28/src/promise.rs#L121 This actually poses a problem when doing anything with JsValues in a future since it violates that future being Send.

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

I added links to these two similar types:

• eventuals::Eventual
• tokio::sync::watch::channel

These are similar to poll_promise::Promise and may be more suitable in some cases.

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.

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

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:

After:

Related Issues

None.