tokio-rs/bytes
1
0
Fork 0
mirror of https://github.com/tokio-rs/bytes.git synced 2026-08-07 00:00:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarify BufMut::advance_mut docs (#78)

Browse Source 
Also fixes an issue with a line wrap in the middle of an inline code
block.
This commit is contained in:
Dan Burkert
2017-03-19 13:53:33 -07:00
committed by Carl Lerche
parent 9a4018e757
commit 4fe4e9429a
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/buf/buf_mut.rs
+4 -4
View File
@@ -59,7 +59,7 @@ pub trait BufMut {
/// further into the underlying buffer.
///
/// This function is unsafe because there is no guarantee that the bytes
/// being advanced to have been initialized.
/// being advanced past have been initialized.
///
/// # Examples
///
@@ -90,9 +90,9 @@ pub trait BufMut {
///
/// # Implementer notes
///
/// It is recommended for implementations of `advance_mut` to panic if `cnt
/// > self.remaining_mut()`. If the implementation does not panic, the call
/// must behave as if `cnt == self.remaining_mut()`.
/// It is recommended for implementations of `advance_mut` to panic if
/// `cnt > self.remaining_mut()`. If the implementation does not panic,
/// the call must behave as if `cnt == self.remaining_mut()`.
///
/// A call with `cnt == 0` should never panic and be a no-op.
unsafe fn advance_mut(&mut self, cnt: usize);