File tree Expand file tree Collapse file tree 1 file changed +10
-1
lines changed Expand file tree Collapse file tree 1 file changed +10
-1
lines changed Original file line number Diff line number Diff line change @@ -506,9 +506,18 @@ pub trait Read {
506506 ///
507507 /// No guarantees are provided about the contents of `buf` when this
508508 /// function is called, implementations cannot rely on any property of the
509- /// contents of `buf` being true. It is recommended that implementations
509+ /// contents of `buf` being true. It is recommended that * implementations*
510510 /// only write data to `buf` instead of reading its contents.
511511 ///
512+ /// Correspondingly, however, *users* of this trait may not assume any guarantees
513+ /// about how the implementation uses `buf`. The trait is safe to implement,
514+ /// so it is perfectly possible that the implementation might inspect that data.
515+ /// As a caller, it is your responsibility to make sure that `buf` is initialized
516+ /// before calling `read`. Calling `read` with an uninitialized `buf` (of the kind one
517+ /// obtains via [`MaybeUninit<T>`]) is not safe, and can lead to undefined behavior.
518+ ///
519+ /// [`MaybeUninit<T>`]: ../mem/union.MaybeUninit.html
520+ ///
512521 /// # Errors
513522 ///
514523 /// If this function encounters any form of I/O or other error, an error
You can’t perform that action at this time.
0 commit comments