Add callback to declare functions/statics safe #3058
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
ojeda
reviewed
Dec 18, 2024
Comment on lines
+471
to
+477
| /* Safety : "safe to access" */ | ||
| pub safe static my_safe_var: [::std::os::raw::c_int; 3usize]; | ||
| } | ||
| unsafe extern "C" { | ||
| /* Safety : "safe to call" */ | ||
| pub safe fn my_safe_func() -> ::std::os::raw::c_int; | ||
| } |
There was a problem hiding this comment.
Are these comments meant to describe only the reason why they are marked as safe, i.e. rather than the full signature being correct? Related: rust-lang/rust-clippy#13560.
There was a problem hiding this comment.
The specific comments are just there to test things are working, they could be replaced by dummy reasoning for test.
The comments can be used to express any kind of safety reasoning. Generally I'd expect people to only reason about why a function is safe to call or a const is safe to access and to rely on bindgen to generate correct bindings.
This was referenced Dec 19, 2024
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.
Since Rust 1.82,
externitems can be marked as safe. This PR adds the ability to mark functions and statics in the generated bindings assafeviaParseCallbacks.To fit into Rust's typical safety comment conventions, the callback returns a string that will be prepended to the generated item as safety comment.
Because
prettypleasedoes not support non-doc comments, I added an additional test usingFormatter::Rustfmt.