Async naming updates and doc fixes #2504
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhammond
approved these changes
Apr 26, 2025
After implementing foreign futures these in JS, I wanted to make some updates. The FFI is staying the same, but some names have been changed. `UniffiForeignFutureFree` is now named `UniffiForeignFutureDroppedCallback` and `UniffiForeignFuture` is now `UniffiForeignFutureDroppedCallbackStruct`. This reflects the fact that we don't really need to use these to manage the future, the real reason they're here nowadays is to support cancellation. For languages like JS, where we can't implement cancellation, we can just ignore these structs and the param. Updated some of the code that deals with this to treat it like the out parameter it is, rather than a return value. I think that was leftover from previous implementations. There's also one change for RustFuture: `RustFuturePoll::MaybeReady` is now `RustFuturePoll::Wake`. "MaybeReady" was always a confusing/ambiguous name. "Wake" seems reasonable, since it's what the foreign bindings should do and reflects how the Rust futures code works. Updated some outdated docstrings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After implementing foreign futures these in JS, I wanted to make some updates. The FFI is staying the same, but some names have been changed.
UniffiForeignFutureFreeis now namedUniffiForeignFutureDroppedCallbackandUniffiForeignFutureis nowUniffiForeignFutureDroppedCallbackStruct. This reflects the fact that we don't really need to use these to manage the future, the real reason they're here nowadays is to support cancellation. For languages like JS, where we can't implement cancellation, we can just ignore the param.Updated some of the code that deals with this to treat it like the out parameter it is, rather than a return value. I think that was leftover from previous implementations.
There's also one change for RustFuture:
RustFuturePoll::MaybeReadyis nowRustFuturePoll::Wake. "MaybeReady" was always a confusing/ambiguous name. "Wake" seems reasonable, since it's what the foreign bindings should do and reflects how the Rust futures code works.Updated some outdated docstrings.