Skip to content

Commit 1a98353

Browse files
committed
Document read_line gotcha
1 parent bb6e76d commit 1a98353

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

library/std/src/io/mod.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2137,8 +2137,10 @@ pub trait BufRead: Read {
21372137
}
21382138

21392139
/// Read all bytes until a newline (the `0xA` byte) is reached, and append
2140-
/// them to the provided buffer. You do not need to clear the buffer before
2141-
/// appending.
2140+
/// them to the provided `String` buffer.
2141+
///
2142+
/// Previous content of the buffer will be preserved. To avoid appending to
2143+
/// the buffer, you need to [`clear`] it first.
21422144
///
21432145
/// This function will read bytes from the underlying stream until the
21442146
/// newline delimiter (the `0xA` byte) or EOF is found. Once found, all bytes
@@ -2154,6 +2156,7 @@ pub trait BufRead: Read {
21542156
/// or EOF.
21552157
///
21562158
/// [`Ok(0)`]: Ok
2159+
/// [`clear`]: String:::clear
21572160
///
21582161
/// # Errors
21592162
///

0 commit comments

Comments
 (0)