Skip to content

Commit 5032745

Browse files
authored
Unrolled build for rust-lang#122277
Rollup merge of rust-lang#122277 - RalfJung:BorrowedCursor, r=cuviper BorrowedCursor docs clarification If one reads the `BorrowedCursor` docs without having seen `BorrowedBuf` before, it is quite easy to assume that "unfilled" and "uninit" are synonyms.
2 parents 3b1717c + c06f801 commit 5032745

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Diff for: library/core/src/io/borrowed_buf.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,11 @@ impl<'data> BorrowedBuf<'data> {
139139
}
140140
}
141141

142-
/// A writeable view of the unfilled portion of a [`BorrowedBuf`](BorrowedBuf).
142+
/// A writeable view of the unfilled portion of a [`BorrowedBuf`].
143+
///
144+
/// The unfilled portion consists of an initialized and an uninitialized part; see [`BorrowedBuf`]
145+
/// for details.
143146
///
144-
/// Provides access to the initialized and uninitialized parts of the underlying `BorrowedBuf`.
145147
/// Data can be written directly to the cursor by using [`append`](BorrowedCursor::append) or
146148
/// indirectly by getting a slice of part or all of the cursor and writing into the slice. In the
147149
/// indirect case, the caller must call [`advance`](BorrowedCursor::advance) after writing to inform

0 commit comments

Comments
 (0)