mirror of
https://github.com/openharmony/third_party_rust_bytes.git
synced 2026-07-18 16:24:29 -04:00
Minor documentation fixes (#351)
* Remove incorrect comment about behavior of put_slice * Improve grammar and clarity of BytesMut documentation
This commit is contained in:
committed by
Sean McArthur
parent
5369a989a4
commit
5a5bb9ed2a
+13
-8
@@ -653,10 +653,11 @@ impl BytesMut {
|
||||
self.len = v.len();
|
||||
self.cap = v.capacity();
|
||||
}
|
||||
/// Appends given bytes to this object.
|
||||
|
||||
/// Appends given bytes to this `BytesMut`.
|
||||
///
|
||||
/// If this `BytesMut` object has not enough capacity, it is resized first.
|
||||
/// So unlike `put_slice` operation, `extend_from_slice` does not panic.
|
||||
/// If this `BytesMut` object does not have enough capacity, it is resized
|
||||
/// first.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@@ -688,9 +689,13 @@ impl BytesMut {
|
||||
unsafe { self.advance_mut(cnt); }
|
||||
}
|
||||
|
||||
/// Combine splitted BytesMut objects back as contiguous.
|
||||
/// Absorbs a `BytesMut` that was previously split off.
|
||||
///
|
||||
/// If `BytesMut` objects were not contiguous originally, they will be extended.
|
||||
/// If the two `BytesMut` objects were previously contiguous, i.e., if
|
||||
/// `other` was created by calling `split_off` on this `BytesMut`, then
|
||||
/// this is an `O(1)` operation that just decreases a reference
|
||||
/// count and sets a few indices. Otherwise this method degenerates to
|
||||
/// `self.extend_from_slice(other.as_ref())`.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@@ -700,11 +705,11 @@ impl BytesMut {
|
||||
/// let mut buf = BytesMut::with_capacity(64);
|
||||
/// buf.extend_from_slice(b"aaabbbcccddd");
|
||||
///
|
||||
/// let splitted = buf.split_off(6);
|
||||
/// let split = buf.split_off(6);
|
||||
/// assert_eq!(b"aaabbb", &buf[..]);
|
||||
/// assert_eq!(b"cccddd", &splitted[..]);
|
||||
/// assert_eq!(b"cccddd", &split[..]);
|
||||
///
|
||||
/// buf.unsplit(splitted);
|
||||
/// buf.unsplit(split);
|
||||
/// assert_eq!(b"aaabbbcccddd", &buf[..]);
|
||||
/// ```
|
||||
pub fn unsplit(&mut self, other: BytesMut) {
|
||||
|
||||
Reference in New Issue
Block a user