diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2024-03-10 22:16:42 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-10 22:16:42 +0100 |
| commit | ff09d32d8321cce425e5f266e1b9372e9b749a20 (patch) | |
| tree | 15353b1681379e5a7222496d81809974f113e1bb | |
| parent | 0c73b2db41f9e472e65300d3fe2864005be0c46b (diff) | |
| parent | c06f801ef6ba6fb3d8467e06d4a35709de4818fd (diff) | |
| download | rust-ff09d32d8321cce425e5f266e1b9372e9b749a20.tar.gz rust-ff09d32d8321cce425e5f266e1b9372e9b749a20.zip | |
Rollup merge of #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.
| -rw-r--r-- | library/core/src/io/borrowed_buf.rs | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/library/core/src/io/borrowed_buf.rs b/library/core/src/io/borrowed_buf.rs index ed06ce6927e..778d38b1537 100644 --- a/library/core/src/io/borrowed_buf.rs +++ b/library/core/src/io/borrowed_buf.rs @@ -139,9 +139,11 @@ impl<'data> BorrowedBuf<'data> { } } -/// A writeable view of the unfilled portion of a [`BorrowedBuf`](BorrowedBuf). +/// A writeable view of the unfilled portion of a [`BorrowedBuf`]. +/// +/// The unfilled portion consists of an initialized and an uninitialized part; see [`BorrowedBuf`] +/// for details. /// -/// Provides access to the initialized and uninitialized parts of the underlying `BorrowedBuf`. /// Data can be written directly to the cursor by using [`append`](BorrowedCursor::append) or /// indirectly by getting a slice of part or all of the cursor and writing into the slice. In the /// indirect case, the caller must call [`advance`](BorrowedCursor::advance) after writing to inform |
