Skip to content

Document that BytesMut::{reserve,try_reserve} doesn't preserve unused capacity #808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Darksonn merged 1 commit into from
Nov 28, 2025
+4 −0
Merged

Document that BytesMut::{reserve,try_reserve} doesn't preserve unused capacity #808

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/bytes_mut.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,8 @@ impl BytesMut {
/// and the original buffer is large enough to fit the requested additional
/// capacity, then reallocations will never happen.
///
/// This method does not preserve data stored in the unused capacity.
///
/// # Examples
///
/// In the following example, a new buffer is allocated.
Expand Down Expand Up @@ -797,6 +799,8 @@ impl BytesMut {
/// references through other `BytesMut`s or `Bytes` which point to the same underlying
/// storage.
///
/// This method does not preserve data stored in the unused capacity.
///
/// # Examples
///
/// ```
Expand Down