uefi-raw: Add API guidelines #992
Merged
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
phip1611
reviewed
Nov 7, 2023
|
|
||
| ## Pointers | ||
|
|
||
| Use pointers (`*const`/`*mut`) instead of references (`&`/`&mut`). |
There was a problem hiding this comment.
Do we want to use some kind of marker which parameters are nullable, input parameters, and output parameters?
There was a problem hiding this comment.
I'm open to the idea, but I'm not sure how to represent it in Rust in a way that would show up in rustdoc.
phip1611
reviewed
Nov 7, 2023
phip1611
approved these changes
Nov 7, 2023
nicholasbishop
force-pushed
the
bishop-api-guide
branch
from
2dcae4a to
6a88082
Compare
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.
Some initial guildelines for the uefi-raw crate. Probably missing some stuff but hopefully this is a good start.
Checklist