Clarify ReadBuf::uninit allows initialized buffers as well #7053
+4
−2
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.
Motivation
The documentation for
ReadBuf::uninit
makes it seem as though the passed buffer must be fully uninitialized; however it allows any buffer, a subset of which is fully uninitialized memory.Note this is more for people like me who are deficient in
unsafe
code; thus the original documentation is likely obvious for those who are well acquainted withunsafe
code.Solution
State the buffer may be fully uninitialized.