Skip to content

Commit

Permalink
Clarify how BytesMut::zeroed works and advantages to manual impl (#714
Browse files Browse the repository at this point in the history
)
  • Loading branch information
paolobarbolini authored Jun 21, 2024
1 parent fa1daac commit 7a5154b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/bytes_mut.rs
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,14 @@ impl BytesMut {
}
}

/// Creates a new `BytesMut`, which is initialized with zero.
/// Creates a new `BytesMut` containing `len` zeros.
///
/// The resulting object has a length of `len` and a capacity greater
/// than or equal to `len`. The entire length of the object will be filled
/// with zeros.
///
/// On some platforms or allocators this function may be faster than
/// a manual implementation.
///
/// # Examples
///
Expand All @@ -273,6 +280,7 @@ impl BytesMut {
///
/// let zeros = BytesMut::zeroed(42);
///
/// assert!(zeros.capacity() >= 42);
/// assert_eq!(zeros.len(), 42);
/// zeros.into_iter().for_each(|x| assert_eq!(x, 0));
/// ```
Expand Down

0 comments on commit 7a5154b

Please sign in to comment.