refactor!: Transfer ownership of action requests in the C API #429
Conversation
This file contains 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
DataTriny
requested changes
Jun 9, 2024
| @@ -1080,9 +1085,9 @@ impl ActivationHandler for FfiActivationHandler { | |||
| } | |||
|
|
|||
| type ActionHandlerCallbackUnwrapped = | |||
| extern "C" fn(request: *const action_request, userdata: *mut c_void); | |||
| extern "C" fn(request: *mut action_request, userdata: *mut c_void); | |||
| pub type ActionHandlerCallback = | |||
There was a problem hiding this comment.
I think we should document the ownership transfer here and mention accesskit_action_handler_free.
DataTriny
reviewed
Jun 9, 2024
bindings/c/src/common.rs
Outdated
| extern "C" fn(request: *mut action_request, userdata: *mut c_void); | ||
|
|
||
| /// Ownership of `request` is transfered to the callback. `request` must | ||
| /// be freed using [`accesskit_action_request_free`]. |
There was a problem hiding this comment.
Suggested change
| /// be freed using [`accesskit_action_request_free`]. | |
| /// be freed using `accesskit_action_request_free`. |
Remember that these doc comments only end up in the header file and not on docs.rs, so I think the brackets are only adding noise.
DataTriny
approved these changes
Jun 9, 2024
Merged
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.
This is the simplest way to allow C API users, like GTK, to asynchronously handle arbitrary action requests on another thread.