diff options
| author | Ralf Jung <post@ralfj.de> | 2024-03-10 09:46:57 +0100 |
|---|---|---|
| committer | Ralf Jung <post@ralfj.de> | 2024-03-10 09:48:56 +0100 |
| commit | c06f801ef6ba6fb3d8467e06d4a35709de4818fd (patch) | |
| tree | ad57b81aa66bbd396f0ed86bba567e8af32802eb | |
| parent | 5bc7b9ac8ace5312e1d2cdc2722715cf58d4f926 (diff) | |
| download | rust-c06f801ef6ba6fb3d8467e06d4a35709de4818fd.tar.gz rust-c06f801ef6ba6fb3d8467e06d4a35709de4818fd.zip | |
BorrowedCursor docs clarification
| -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 |
