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
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};

pub use futures_io::AsyncBufRead as BufRead;

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

    [`BufRead`]: ../trait.BufRead.html
"#]
pub trait BufReadExt: BufRead {
    #[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>,
    ) -> 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,
    ) -> 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 + ?Sized> BufReadExt for T {}

pub(crate) 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)));
        }
    }
}