aboutsummaryrefslogtreecommitdiff
path: root/src/buf/buf_impl.rs
diff options
context:
space:
mode:
authorGravatar Alice Ryhl <alice@ryhl.io> 2021-01-23 07:22:43 +0100
committerGravatar GitHub <noreply@github.com> 2021-01-23 15:22:43 +0900
commite4182808df772e331fbd25c48f2f1ab79c0d7c20 (patch)
treecb21ac617cbb35af592eb14d04df4bdda0756594 /src/buf/buf_impl.rs
parent8daf43e9bde134e32fc0b8938abc92695f6850d1 (diff)
downloadbytes-e4182808df772e331fbd25c48f2f1ab79c0d7c20.tar.gz
bytes-e4182808df772e331fbd25c48f2f1ab79c0d7c20.tar.zst
bytes-e4182808df772e331fbd25c48f2f1ab79c0d7c20.zip
Make bytes_mut -> chunk_mut rename more easily discoverable (#471)
Diffstat (limited to 'src/buf/buf_impl.rs')
-rw-r--r--src/buf/buf_impl.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/buf/buf_impl.rs b/src/buf/buf_impl.rs
index 16ad8a7..a33c8a4 100644
--- a/src/buf/buf_impl.rs
+++ b/src/buf/buf_impl.rs
@@ -127,6 +127,9 @@ pub trait Buf {
/// This function should never panic. Once the end of the buffer is reached,
/// i.e., `Buf::remaining` returns 0, calls to `chunk()` should return an
/// empty slice.
+ // The `chunk` method was previously called `bytes`. This alias makes the rename
+ // more easily discoverable.
+ #[cfg_attr(docsrs, doc(alias = "bytes"))]
fn chunk(&self) -> &[u8];
/// Fills `dst` with potentially multiple slices starting at `self`'s