Clarify as_uninit_mut may point to uninitialized memory#158804
Open
yilin0518 wants to merge 1 commit into
Open
Clarify as_uninit_mut may point to uninitialized memory#158804yilin0518 wants to merge 1 commit into
as_uninit_mut may point to uninitialized memory#158804yilin0518 wants to merge 1 commit into
Conversation
Collaborator
|
r? @LawnGnome rustbot has assigned @LawnGnome. Use Why was this reviewer chosen?The reviewer was selected based on:
|
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
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.
Tracking issue: #75402
This PR clarifies the safety documentation for
*mut T::as_uninit_mut.Unlike
as_mut, this method creates a reference toMaybeUninit<T>, so the source pointer may point to uninitialized memory. The pointer still must either be null or satisfy the pointer-to-reference conversion requirements.After adding the supplementary information, the safety documentation of
*mut T::as_uninit_mutis consistent with*mut T::as_uninit_ref,*const T::as_uninit_refandstd::ptr::NonNull::as_uninit_mut.This is a documentation-only change.
Tests were not added because this only updates API docs.