From ca2b5a5a37767580f6022eb698c7ce2259fc2c6e Mon Sep 17 00:00:00 2001 From: Lucio Franco Date: Mon, 12 Oct 2020 16:03:05 +0000 Subject: [PATCH] io: Rename `ReadBuf` methods This changes `ReadBuf::add_filled` to `ReadBuf::advance` and `ReadBuf::append` to `ReadBuf::put_slice`. This is just a mechanical change. Closes #2769 --- tokio-test/src/io.rs | 2 +- tokio-util/src/compat.rs | 2 +- tokio-util/src/io/stream_reader.rs | 2 +- tokio-util/tests/framed_read.rs | 2 +- tokio-util/tests/io_reader_stream.rs | 2 +- tokio-util/tests/length_delimited.rs | 2 +- tokio/src/io/async_read.rs | 4 ++-- tokio/src/io/blocking.rs | 2 +- tokio/src/io/poll_evented.rs | 2 +- tokio/src/io/read_buf.rs | 6 +++--- tokio/src/io/util/buf_reader.rs | 2 +- tokio/src/io/util/mem.rs | 2 +- tokio/src/io/util/repeat.rs | 2 +- tokio/src/io/util/take.rs | 2 +- tokio/src/net/tcp/stream.rs | 2 +- tokio/src/net/unix/stream.rs | 2 +- tokio/tests/io_copy.rs | 2 +- tokio/tests/io_read.rs | 2 +- tokio/tests/io_split.rs | 2 +- 19 files changed, 22 insertions(+), 22 deletions(-) diff --git a/tokio-test/src/io.rs b/tokio-test/src/io.rs index 7cfad2eca73..b68929a84a3 100644 --- a/tokio-test/src/io.rs +++ b/tokio-test/src/io.rs @@ -212,7 +212,7 @@ impl Inner { let n = cmp::min(dst.remaining(), data.len()); // Copy the data into the `dst` slice - dst.append(&data[..n]); + dst.put_slice(&data[..n]); // Drain the data from the source data.drain(..n); diff --git a/tokio-util/src/compat.rs b/tokio-util/src/compat.rs index 34120d43a34..f755c9b6b34 100644 --- a/tokio-util/src/compat.rs +++ b/tokio-util/src/compat.rs @@ -118,7 +118,7 @@ where cx, slice ))?; - buf.add_filled(n); + buf.advance(n); Poll::Ready(Ok(())) } } diff --git a/tokio-util/src/io/stream_reader.rs b/tokio-util/src/io/stream_reader.rs index def843b1ddd..99079c73d1a 100644 --- a/tokio-util/src/io/stream_reader.rs +++ b/tokio-util/src/io/stream_reader.rs @@ -114,7 +114,7 @@ where Poll::Pending => return Poll::Pending, }; let len = std::cmp::min(inner_buf.len(), buf.remaining()); - buf.append(&inner_buf[..len]); + buf.put_slice(&inner_buf[..len]); self.consume(len); Poll::Ready(Ok(())) diff --git a/tokio-util/tests/framed_read.rs b/tokio-util/tests/framed_read.rs index 52c30ef980e..0ce8118ee9e 100644 --- a/tokio-util/tests/framed_read.rs +++ b/tokio-util/tests/framed_read.rs @@ -271,7 +271,7 @@ impl AsyncRead for Mock { match self.calls.pop_front() { Some(Ok(data)) => { debug_assert!(buf.remaining() >= data.len()); - buf.append(&data); + buf.put_slice(&data); Ready(Ok(())) } Some(Err(ref e)) if e.kind() == WouldBlock => Pending, diff --git a/tokio-util/tests/io_reader_stream.rs b/tokio-util/tests/io_reader_stream.rs index b906de097e2..91986c8e3b5 100644 --- a/tokio-util/tests/io_reader_stream.rs +++ b/tokio-util/tests/io_reader_stream.rs @@ -25,7 +25,7 @@ impl AsyncRead for Reader { for x in &mut buf.initialize_unfilled_to(n)[..n] { *x = 0; } - buf.add_filled(n); + buf.advance(n); this.remaining -= n; Poll::Ready(Ok(())) } else { diff --git a/tokio-util/tests/length_delimited.rs b/tokio-util/tests/length_delimited.rs index 9f615412875..126e41b5cd3 100644 --- a/tokio-util/tests/length_delimited.rs +++ b/tokio-util/tests/length_delimited.rs @@ -712,7 +712,7 @@ impl AsyncRead for Mock { match self.calls.pop_front() { Some(Ready(Ok(Op::Data(data)))) => { debug_assert!(dst.remaining() >= data.len()); - dst.append(&data); + dst.put_slice(&data); Ready(Ok(())) } Some(Ready(Ok(_))) => panic!(), diff --git a/tokio/src/io/async_read.rs b/tokio/src/io/async_read.rs index ba2303d1d2f..b9b0f4378e4 100644 --- a/tokio/src/io/async_read.rs +++ b/tokio/src/io/async_read.rs @@ -97,7 +97,7 @@ impl AsyncRead for &[u8] { ) -> Poll> { let amt = std::cmp::min(self.len(), buf.remaining()); let (a, b) = self.split_at(amt); - buf.append(a); + buf.put_slice(a); *self = b; Poll::Ready(Ok(())) } @@ -121,7 +121,7 @@ impl + Unpin> AsyncRead for io::Cursor { let amt = std::cmp::min(slice.len() - start, buf.remaining()); // Add won't overflow because of pos check above. let end = start + amt; - buf.append(&slice[start..end]); + buf.put_slice(&slice[start..end]); self.set_position(end as u64); Poll::Ready(Ok(())) diff --git a/tokio/src/io/blocking.rs b/tokio/src/io/blocking.rs index d2265a00aa2..430801ee730 100644 --- a/tokio/src/io/blocking.rs +++ b/tokio/src/io/blocking.rs @@ -205,7 +205,7 @@ impl Buf { pub(crate) fn copy_to(&mut self, dst: &mut ReadBuf<'_>) -> usize { let n = cmp::min(self.len(), dst.remaining()); - dst.append(&self.bytes()[..n]); + dst.put_slice(&self.bytes()[..n]); self.pos += n; if self.pos == self.buf.len() { diff --git a/tokio/src/io/poll_evented.rs b/tokio/src/io/poll_evented.rs index 4457195fd76..f253f0bb43d 100644 --- a/tokio/src/io/poll_evented.rs +++ b/tokio/src/io/poll_evented.rs @@ -249,7 +249,7 @@ impl AsyncRead for PollEvented { } return Poll::Ready(r.map(|n| { - buf.add_filled(n); + buf.advance(n); })); } } diff --git a/tokio/src/io/read_buf.rs b/tokio/src/io/read_buf.rs index 8b430ee1093..b64d95ceb8c 100644 --- a/tokio/src/io/read_buf.rs +++ b/tokio/src/io/read_buf.rs @@ -171,7 +171,7 @@ impl<'a> ReadBuf<'a> { self.filled = 0; } - /// Increases the size of the filled region of the buffer. + /// Advances the size of the filled region of the buffer. /// /// The number of initialized bytes is not changed. /// @@ -179,7 +179,7 @@ impl<'a> ReadBuf<'a> { /// /// Panics if the filled region of the buffer would become larger than the initialized region. #[inline] - pub fn add_filled(&mut self, n: usize) { + pub fn advance(&mut self, n: usize) { let new = self.filled.checked_add(n).expect("filled overflow"); self.set_filled(new); } @@ -225,7 +225,7 @@ impl<'a> ReadBuf<'a> { /// /// Panics if `self.remaining()` is less than `buf.len()`. #[inline] - pub fn append(&mut self, buf: &[u8]) { + pub fn put_slice(&mut self, buf: &[u8]) { assert!( self.remaining() >= buf.len(), "buf.len() must fit in remaining()" diff --git a/tokio/src/io/util/buf_reader.rs b/tokio/src/io/util/buf_reader.rs index 9264ca59e2a..271f61bf2ae 100644 --- a/tokio/src/io/util/buf_reader.rs +++ b/tokio/src/io/util/buf_reader.rs @@ -111,7 +111,7 @@ impl AsyncRead for BufReader { } let rem = ready!(self.as_mut().poll_fill_buf(cx))?; let amt = std::cmp::min(rem.len(), buf.remaining()); - buf.append(&rem[..amt]); + buf.put_slice(&rem[..amt]); self.consume(amt); Poll::Ready(Ok(())) } diff --git a/tokio/src/io/util/mem.rs b/tokio/src/io/util/mem.rs index 0dd6ad77d4c..e91a9328b88 100644 --- a/tokio/src/io/util/mem.rs +++ b/tokio/src/io/util/mem.rs @@ -167,7 +167,7 @@ impl AsyncRead for Pipe { ) -> Poll> { if self.buffer.has_remaining() { let max = self.buffer.remaining().min(buf.remaining()); - buf.append(&self.buffer[..max]); + buf.put_slice(&self.buffer[..max]); self.buffer.advance(max); if max > 0 { // The passed `buf` might have been empty, don't wake up if diff --git a/tokio/src/io/util/repeat.rs b/tokio/src/io/util/repeat.rs index b942691d331..1142765df5c 100644 --- a/tokio/src/io/util/repeat.rs +++ b/tokio/src/io/util/repeat.rs @@ -55,7 +55,7 @@ impl AsyncRead for Repeat { ) -> Poll> { // TODO: could be faster, but should we unsafe it? while buf.remaining() != 0 { - buf.append(&[self.byte]); + buf.put_slice(&[self.byte]); } Poll::Ready(Ok(())) } diff --git a/tokio/src/io/util/take.rs b/tokio/src/io/util/take.rs index 4e424f6c8a5..b5e90c936fa 100644 --- a/tokio/src/io/util/take.rs +++ b/tokio/src/io/util/take.rs @@ -93,7 +93,7 @@ impl AsyncRead for Take { unsafe { buf.assume_init(n); } - buf.add_filled(n); + buf.advance(n); *me.limit_ -= n as u64; Poll::Ready(Ok(())) } diff --git a/tokio/src/net/tcp/stream.rs b/tokio/src/net/tcp/stream.rs index ee24ee32e98..0a58e481310 100644 --- a/tokio/src/net/tcp/stream.rs +++ b/tokio/src/net/tcp/stream.rs @@ -503,7 +503,7 @@ impl TcpStream { unsafe { buf.assume_init(n); } - buf.add_filled(n); + buf.advance(n); return Poll::Ready(Ok(())); } Err(e) => return Poll::Ready(Err(e)), diff --git a/tokio/src/net/unix/stream.rs b/tokio/src/net/unix/stream.rs index d0f98f438b3..c539f2246e2 100644 --- a/tokio/src/net/unix/stream.rs +++ b/tokio/src/net/unix/stream.rs @@ -215,7 +215,7 @@ impl UnixStream { unsafe { buf.assume_init(n); } - buf.add_filled(n); + buf.advance(n); return Poll::Ready(Ok(())); } Err(e) => return Poll::Ready(Err(e)), diff --git a/tokio/tests/io_copy.rs b/tokio/tests/io_copy.rs index aed6c789d23..9ed7995c75e 100644 --- a/tokio/tests/io_copy.rs +++ b/tokio/tests/io_copy.rs @@ -18,7 +18,7 @@ async fn copy() { buf: &mut ReadBuf<'_>, ) -> Poll> { if self.0 { - buf.append(b"hello world"); + buf.put_slice(b"hello world"); self.0 = false; Poll::Ready(Ok(())) } else { diff --git a/tokio/tests/io_read.rs b/tokio/tests/io_read.rs index 0a717cf519e..29d7d6d7f15 100644 --- a/tokio/tests/io_read.rs +++ b/tokio/tests/io_read.rs @@ -24,7 +24,7 @@ async fn read() { assert_eq!(0, self.poll_cnt); self.poll_cnt += 1; - buf.append(b"hello world"); + buf.put_slice(b"hello world"); Poll::Ready(Ok(())) } } diff --git a/tokio/tests/io_split.rs b/tokio/tests/io_split.rs index 7b401424151..db168e9f816 100644 --- a/tokio/tests/io_split.rs +++ b/tokio/tests/io_split.rs @@ -15,7 +15,7 @@ impl AsyncRead for RW { _cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll> { - buf.append(&[b'z']); + buf.put_slice(&[b'z']); Poll::Ready(Ok(())) } }