mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

BorrowedCursor docs clarification

Browse Source
This commit is contained in:
Ralf Jung 2024-03-10 09:46:57 +01:00
parent 5bc7b9ac8a
commit c06f801ef6
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
library/core/src/io/borrowed_buf.rs
View File

@ -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 /// 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 /// 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 /// indirect case, the caller must call [`advance`](BorrowedCursor::advance) after writing to inform