Skip to content

Commit

Permalink
Clarifying actions of clear and truncate. (tokio-rs#508)
Browse files Browse the repository at this point in the history
  • Loading branch information
chotchki authored and lelongg committed Jan 9, 2023
1 parent b48282b commit fab3786
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/bytes_mut.rs
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,8 @@ impl BytesMut {
/// If `len` is greater than the buffer's current length, this has no
/// effect.
///
/// Existing underlying capacity is preserved.
///
/// The [`split_off`] method can emulate `truncate`, but this causes the
/// excess bytes to be returned instead of dropped.
///
Expand All @@ -402,7 +404,7 @@ impl BytesMut {
}
}

/// Clears the buffer, removing all data.
/// Clears the buffer, removing all data. Existing capacity is preserved.
///
/// # Examples
///
Expand Down

0 comments on commit fab3786

Please sign in to comment.