add notes about alignment-altering reallocations to Allocator docs #95546
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
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
@bors r+ |
|
📌 Commit e246682 has been approved by |
bors
added
S-waiting-on-bors
|
@bors rollup |
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Apr 1, 2022
…n-docs, r=Amanieu add notes about alignment-altering reallocations to Allocator docs As I said in rust-lang/wg-allocators#97, the fact that calls to `grow`, `grow_zeroed`, and `shrink` may request altered alignments is surprising and may be a pitfall for implementors of `Allocator` if it's left implicit. This pull request adds a note to the "Safety" section of each function's docs making it explicit.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Apr 1, 2022
…askrgr Rollup of 6 pull requests Successful merges: - rust-lang#95475 (rustdoc: Only show associated consts from inherent impls in sidebar) - rust-lang#95516 (ptr_metadata test: avoid ptr-to-int transmutes) - rust-lang#95528 (skip slow int_log tests in Miri) - rust-lang#95531 (expand: Do not count metavar declarations on RHS of `macro_rules`) - rust-lang#95532 (make utf8_char_counts test faster in Miri) - rust-lang#95546 (add notes about alignment-altering reallocations to Allocator docs) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
As I said in rust-lang/wg-allocators#97, the fact that calls to
grow,grow_zeroed, andshrinkmay request altered alignments is surprising and may be a pitfall for implementors ofAllocatorif it's left implicit. This pull request adds a note to the "Safety" section of each function's docs making it explicit.