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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
mod lines;
mod read_line;
mod read_until;
mod split;

pub use lines::Lines;
pub use split::Split;

use read_line::ReadLineFuture;
use read_until::ReadUntilFuture;

use std::mem;
use std::pin::Pin;

use crate::io;
use crate::task::{Context, Poll};

extension_trait! {
    use std::ops::{Deref, DerefMut};

    #[doc = r#"
        Allows reading from a buffered byte stream.

        This trait is a re-export of [`futures::io::AsyncBufRead`] and is an async version of
        [`std::io::BufRead`].

        The [provided methods] do not really exist in the trait itself, but they become
        available when [`BufReadExt`] from the [prelude] is imported:

        ```
        # #[allow(unused_imports)]
        use async_std::io::prelude::*;
        ```

        [`std::io::BufRead`]: https://doc.rust-lang.org/std/io/trait.BufRead.html
        [`futures::io::AsyncBufRead`]:
        https://docs.rs/futures/0.3/futures/io/trait.AsyncBufRead.html
        [provided methods]: #provided-methods
        [`BufReadExt`]: ../io/prelude/trait.BufReadExt.html
        [prelude]: ../prelude/index.html
    "#]
    pub trait BufRead {
        #[doc = r#"
            Returns the contents of the internal buffer, filling it with more data from the
            inner reader if it is empty.

            This function is a lower-level call. It needs to be paired with the [`consume`]
            method to function properly. When calling this method, none of the contents will be
            "read" in the sense that later calling `read` may return the same contents. As
            such, [`consume`] must be called with the number of bytes that are consumed from
            this buffer to ensure that the bytes are never returned twice.

            [`consume`]: #tymethod.consume

            An empty buffer returned indicates that the stream has reached EOF.
        "#]
        // TODO: write a proper doctest with `consume`
        fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&[u8]>>;

        #[doc = r#"
            Tells this buffer that `amt` bytes have been consumed from the buffer, so they
            should no longer be returned in calls to `read`.
        "#]
        fn consume(self: Pin<&mut Self>, amt: usize);
    }

    #[doc = r#"
        Extension methods for [`BufRead`].

        [`BufRead`]: ../trait.BufRead.html
    "#]
    pub trait BufReadExt: futures_io::AsyncBufRead {
        #[doc = r#"
            Reads all bytes into `buf` until the delimiter `byte` or EOF is reached.

            This function will read bytes from the underlying stream until the delimiter or EOF
            is found. Once found, all bytes up to, and including, the delimiter (if found) will
            be appended to `buf`.

            If successful, this function will return the total number of bytes read.

            # Examples

            ```no_run
            # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
            #
            use async_std::fs::File;
            use async_std::io::BufReader;
            use async_std::prelude::*;

            let mut file = BufReader::new(File::open("a.txt").await?);

            let mut buf = Vec::with_capacity(1024);
            let n = file.read_until(b'\n', &mut buf).await?;
            #
            # Ok(()) }) }
            ```

            Multiple successful calls to `read_until` append all bytes up to and including to
            `buf`:
            ```
            # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
            #
            use async_std::io::BufReader;
            use async_std::prelude::*;

            let from: &[u8] = b"append\nexample\n";
            let mut reader = BufReader::new(from);
            let mut buf = vec![];

            let mut size = reader.read_until(b'\n', &mut buf).await?;
            assert_eq!(size, 7);
            assert_eq!(buf, b"append\n");

            size += reader.read_until(b'\n', &mut buf).await?;
            assert_eq!(size, from.len());

            assert_eq!(buf, from);
            #
            # Ok(()) }) }
            ```
        "#]
        fn read_until<'a>(
            &'a mut self,
            byte: u8,
            buf: &'a mut Vec<u8>,
        ) -> impl Future<Output = usize> + 'a [ReadUntilFuture<'a, Self>]
        where
            Self: Unpin,
        {
            ReadUntilFuture {
                reader: self,
                byte,
                buf,
                read: 0,
            }
        }

        #[doc = r#"
            Reads all bytes and appends them into `buf` until a newline (the 0xA byte) is
            reached.

            This function will read bytes from the underlying stream until the newline
            delimiter (the 0xA byte) or EOF is found. Once found, all bytes up to, and
            including, the delimiter (if found) will be appended to `buf`.

            If successful, this function will return the total number of bytes read.

            If this function returns `Ok(0)`, the stream has reached EOF.

            # Errors

            This function has the same error semantics as [`read_until`] and will also return
            an error if the read bytes are not valid UTF-8. If an I/O error is encountered then
            `buf` may contain some bytes already read in the event that all data read so far
            was valid UTF-8.

            [`read_until`]: #method.read_until

            # Examples

            ```no_run
            # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
            #
            use async_std::fs::File;
            use async_std::io::BufReader;
            use async_std::prelude::*;

            let mut file = BufReader::new(File::open("a.txt").await?);

            let mut buf = String::new();
            file.read_line(&mut buf).await?;
            #
            # Ok(()) }) }
            ```
        "#]
        fn read_line<'a>(
            &'a mut self,
            buf: &'a mut String,
        ) -> impl Future<Output = io::Result<usize>> + 'a [ReadLineFuture<'a, Self>]
        where
            Self: Unpin,
        {
            ReadLineFuture {
                reader: self,
                bytes: unsafe { mem::replace(buf.as_mut_vec(), Vec::new()) },
                buf,
                read: 0,
            }
        }

        #[doc = r#"
            Returns a stream over the lines of this byte stream.

            The stream returned from this function will yield instances of
            [`io::Result`]`<`[`String`]`>`. Each string returned will *not* have a newline byte
            (the 0xA byte) or CRLF (0xD, 0xA bytes) at the end.

            [`io::Result`]: type.Result.html
            [`String`]: https://doc.rust-lang.org/std/string/struct.String.html

            # Examples

            ```no_run
            # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
            #
            use async_std::fs::File;
            use async_std::io::BufReader;
            use async_std::prelude::*;

            let file = File::open("a.txt").await?;
            let mut lines = BufReader::new(file).lines();
            let mut count = 0;

            while let Some(line) = lines.next().await {
                line?;
                count += 1;
            }
            #
            # Ok(()) }) }
            ```
        "#]
        fn lines(self) -> Lines<Self>
        where
            Self: Unpin + Sized,
        {
            Lines {
                reader: self,
                buf: String::new(),
                bytes: Vec::new(),
                read: 0,
            }
        }

        #[doc = r#"
            Returns a stream over the contents of this reader split on the byte `byte`.

            The stream returned from this function will return instances of
            [`io::Result`]`<`[`Vec<u8>`]`>`. Each vector returned will *not* have
            the delimiter byte at the end.

            This function will yield errors whenever [`read_until`] would have
            also yielded an error.

            [`io::Result`]: type.Result.html
            [`Vec<u8>`]: ../vec/struct.Vec.html
            [`read_until`]: #method.read_until

            # Examples

            [`std::io::Cursor`][`Cursor`] is a type that implements `BufRead`. In
            this example, we use [`Cursor`] to iterate over all hyphen delimited
            segments in a byte slice

            [`Cursor`]: struct.Cursor.html

            ```
            # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
            #
            use async_std::prelude::*;
            use async_std::io;

            let cursor = io::Cursor::new(b"lorem-ipsum-dolor");

            let mut split_iter = cursor.split(b'-').map(|l| l.unwrap());
            assert_eq!(split_iter.next().await, Some(b"lorem".to_vec()));
            assert_eq!(split_iter.next().await, Some(b"ipsum".to_vec()));
            assert_eq!(split_iter.next().await, Some(b"dolor".to_vec()));
            assert_eq!(split_iter.next().await, None);
            #
            # Ok(()) }) }
            ```
        "#]
        fn split(self, byte: u8) -> Split<Self>
        where
            Self: Sized,
        {
            Split {
                reader: self,
                buf: Vec::new(),
                delim: byte,
                read: 0,
            }
        }
    }

    impl<T: BufRead + Unpin + ?Sized> BufRead for Box<T> {
        fn poll_fill_buf(
            self: Pin<&mut Self>,
            cx: &mut Context<'_>,
        ) -> Poll<io::Result<&[u8]>> {
            unreachable!("this impl only appears in the rendered docs")
        }

        fn consume(self: Pin<&mut Self>, amt: usize) {
            unreachable!("this impl only appears in the rendered docs")
        }
    }

    impl<T: BufRead + Unpin + ?Sized> BufRead for &mut T {
        fn poll_fill_buf(
            self: Pin<&mut Self>,
            cx: &mut Context<'_>,
        ) -> Poll<io::Result<&[u8]>> {
            unreachable!("this impl only appears in the rendered docs")
        }

        fn consume(self: Pin<&mut Self>, amt: usize) {
            unreachable!("this impl only appears in the rendered docs")
        }
    }

    impl<P> BufRead for Pin<P>
    where
        P: DerefMut + Unpin,
        <P as Deref>::Target: BufRead,
    {
        fn poll_fill_buf(
            self: Pin<&mut Self>,
            cx: &mut Context<'_>,
        ) -> Poll<io::Result<&[u8]>> {
            unreachable!("this impl only appears in the rendered docs")
        }

        fn consume(self: Pin<&mut Self>, amt: usize) {
            unreachable!("this impl only appears in the rendered docs")
        }
    }

    impl BufRead for &[u8] {
        fn poll_fill_buf(
            self: Pin<&mut Self>,
            cx: &mut Context<'_>,
        ) -> Poll<io::Result<&[u8]>> {
            unreachable!()
        }

        fn consume(self: Pin<&mut Self>, amt: usize) {
            unreachable!("this impl only appears in the rendered docs")
        }
    }
}

pub fn read_until_internal<R: BufReadExt + ?Sized>(
    mut reader: Pin<&mut R>,
    cx: &mut Context<'_>,
    byte: u8,
    buf: &mut Vec<u8>,
    read: &mut usize,
) -> Poll<io::Result<usize>> {
    loop {
        let (done, used) = {
            let available = futures_core::ready!(reader.as_mut().poll_fill_buf(cx))?;
            if let Some(i) = memchr::memchr(byte, available) {
                buf.extend_from_slice(&available[..=i]);
                (true, i + 1)
            } else {
                buf.extend_from_slice(available);
                (false, available.len())
            }
        };
        reader.as_mut().consume(used);
        *read += used;
        if done || used == 0 {
            return Poll::Ready(Ok(mem::replace(read, 0)));
        }
    }
}