1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
use futures_core::task::{Context, Poll}; #[cfg(feature = "read-initializer")] use futures_io::Initializer; use futures_io::{AsyncRead, AsyncBufRead}; use pin_utils::{unsafe_pinned, unsafe_unpinned}; use std::{cmp, io}; use std::pin::Pin; /// Reader for the [`take`](super::AsyncReadExt::take) method. #[derive(Debug)] #[must_use = "readers do nothing unless you `.await` or poll them"] pub struct Take<R> { inner: R, // Add '_' to avoid conflicts with `limit` method. limit_: u64, } impl<R: Unpin> Unpin for Take<R> { } impl<R: AsyncRead> Take<R> { unsafe_pinned!(inner: R); unsafe_unpinned!(limit_: u64); pub(super) fn new(inner: R, limit: u64) -> Self { Self { inner, limit_: limit } } /// Returns the remaining number of bytes that can be /// read before this instance will return EOF. /// /// # Note /// /// This instance may reach `EOF` after reading fewer bytes than indicated by /// this method if the underlying [`AsyncRead`] instance reaches EOF. /// /// # Examples /// /// ``` /// # futures::executor::block_on(async { /// use futures::io::{AsyncReadExt, Cursor}; /// /// let reader = Cursor::new(&b"12345678"[..]); /// let mut buffer = [0; 2]; /// /// let mut take = reader.take(4); /// let n = take.read(&mut buffer).await?; /// /// assert_eq!(take.limit(), 2); /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap(); /// ``` pub fn limit(&self) -> u64 { self.limit_ } /// Sets the number of bytes that can be read before this instance will /// return EOF. This is the same as constructing a new `Take` instance, so /// the amount of bytes read and the previous limit value don't matter when /// calling this method. /// /// # Examples /// /// ``` /// # futures::executor::block_on(async { /// use futures::io::{AsyncReadExt, Cursor}; /// /// let reader = Cursor::new(&b"12345678"[..]); /// let mut buffer = [0; 4]; /// /// let mut take = reader.take(4); /// let n = take.read(&mut buffer).await?; /// /// assert_eq!(n, 4); /// assert_eq!(take.limit(), 0); /// /// take.set_limit(10); /// let n = take.read(&mut buffer).await?; /// assert_eq!(n, 4); /// /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap(); /// ``` pub fn set_limit(&mut self, limit: u64) { self.limit_ = limit } /// Gets a reference to the underlying reader. /// /// # Examples /// /// ``` /// # futures::executor::block_on(async { /// use futures::io::{AsyncReadExt, Cursor}; /// /// let reader = Cursor::new(&b"12345678"[..]); /// let mut buffer = [0; 4]; /// /// let mut take = reader.take(4); /// let n = take.read(&mut buffer).await?; /// /// let cursor_ref = take.get_ref(); /// assert_eq!(cursor_ref.position(), 4); /// /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap(); /// ``` pub fn get_ref(&self) -> &R { &self.inner } /// Gets a mutable reference to the underlying reader. /// /// Care should be taken to avoid modifying the internal I/O state of the /// underlying reader as doing so may corrupt the internal limit of this /// `Take`. /// /// # Examples /// /// ``` /// # futures::executor::block_on(async { /// use futures::io::{AsyncReadExt, Cursor}; /// /// let reader = Cursor::new(&b"12345678"[..]); /// let mut buffer = [0; 4]; /// /// let mut take = reader.take(4); /// let n = take.read(&mut buffer).await?; /// /// let cursor_mut = take.get_mut(); /// /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap(); /// ``` pub fn get_mut(&mut self) -> &mut R { &mut self.inner } /// Gets a pinned mutable reference to the underlying reader. /// /// Care should be taken to avoid modifying the internal I/O state of the /// underlying reader as doing so may corrupt the internal limit of this /// `Take`. pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R> { self.inner() } /// Consumes the `Take`, returning the wrapped reader. /// /// # Examples /// /// ``` /// # futures::executor::block_on(async { /// use futures::io::{AsyncReadExt, Cursor}; /// /// let reader = Cursor::new(&b"12345678"[..]); /// let mut buffer = [0; 4]; /// /// let mut take = reader.take(4); /// let n = take.read(&mut buffer).await?; /// /// let cursor = take.into_inner(); /// assert_eq!(cursor.position(), 4); /// /// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap(); /// ``` pub fn into_inner(self) -> R { self.inner } } impl<R: AsyncRead> AsyncRead for Take<R> { fn poll_read( mut self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, io::Error>> { if self.limit_ == 0 { return Poll::Ready(Ok(0)); } let max = std::cmp::min(buf.len() as u64, self.limit_) as usize; let n = ready!(self.as_mut().inner().poll_read(cx, &mut buf[..max]))?; *self.as_mut().limit_() -= n as u64; Poll::Ready(Ok(n)) } #[cfg(feature = "read-initializer")] unsafe fn initializer(&self) -> Initializer { self.inner.initializer() } } impl<R: AsyncBufRead> AsyncBufRead for Take<R> { fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&[u8]>> { let Self { inner, limit_ } = unsafe { self.get_unchecked_mut() }; let inner = unsafe { Pin::new_unchecked(inner) }; // Don't call into inner reader at all at EOF because it may still block if *limit_ == 0 { return Poll::Ready(Ok(&[])); } let buf = ready!(inner.poll_fill_buf(cx)?); let cap = cmp::min(buf.len() as u64, *limit_) as usize; Poll::Ready(Ok(&buf[..cap])) } fn consume(mut self: Pin<&mut Self>, amt: usize) { // Don't let callers reset the limit by passing an overlarge value let amt = cmp::min(amt as u64, self.limit_) as usize; *self.as_mut().limit_() -= amt as u64; self.inner().consume(amt); } }