-
Notifications
You must be signed in to change notification settings - Fork 689
Add introduction/constants/enumeration/uninitialized to CONVENTIONS. #282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,44 @@ | ||
# Bitflags | ||
# Conventions | ||
|
||
In order to achieve our goal of wrapping [libc][libc] code in idiomatic rust | ||
constructs with minimal performance overhead, we follow the following | ||
conventions. | ||
|
||
Note that, thus far, not all the code follows these conventions and not all | ||
conventions we try to follow have been documented here. If you find an instance | ||
of either, feel free to remedy the flaw by opening a pull request with | ||
appropriate changes or additions. | ||
|
||
|
||
## Integer Constants | ||
|
||
We do not define integer constants ourselves, but use or reexport them from the | ||
[libc crate][libc]. | ||
|
||
|
||
## Bitflags | ||
|
||
We represent sets of constants that are intended to be combined using bitwise | ||
operations as parameters to functions by types defined using the `bitflags!` | ||
macro from the [bitflags crate](https://crates.io/crates/bitflags/). | ||
Instead of providing the concrete values ourselves, we prefer taking the | ||
constants defined in [libc crate](https://crates.io/crates/libc/). | ||
macro from the [bitflags crate][bitflags]. | ||
|
||
|
||
## Enumerations | ||
|
||
We represent sets of constants that are intended as mutually exclusive arguments | ||
to parameters of functions by [enumerations][enum]. | ||
|
||
|
||
## Structures Initialized by libc Functions | ||
|
||
Whenever we need to use a [libc][libc] function to properly initialize a | ||
variable and said function allows us to use uninitialized memory, we use | ||
[`std::mem::uninitialized`][std_uninitialized] (or [`core::mem::uninitialized`][core_uninitialized]) | ||
when defining the variable. This allows us to avoid the overhead incurred by | ||
zeroing or otherwise initializing the variable. | ||
|
||
[bitflags]: https://crates.io/crates/bitflags/ | ||
[core_uninitialized]: https://doc.rust-lang.org/core/mem/fn.uninitialized.html | ||
[enum]: https://doc.rust-lang.org/reference.html#enumerations | ||
[libc]: https://crates.io/crates/libc/ | ||
[std_uninitialized]: https://doc.rust-lang.org/std/mem/fn.uninitialized.html |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really minor: add a
# Conventions
or similar title up here, and make the lower headings h2 (##
)