about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorTomasz Miąsko <tomasz.miasko@gmail.com>2016-09-30 00:00:00 +0200
committerTomasz Miąsko <tomasz.miasko@gmail.com>2016-09-30 11:58:10 +0200
commit1e8f6924613705f6687de3679846b28e8aaa4ba0 (patch)
tree6fed428eda3284064b6b3e2cb12fe71624a4e494 /src/libstd
parent7660bdf70ae0c6a434dd12cfdeb8250ce77c69c7 (diff)
downloadrust-1e8f6924613705f6687de3679846b28e8aaa4ba0.tar.gz
rust-1e8f6924613705f6687de3679846b28e8aaa4ba0.zip
Fix BufRead::{read_until, read_line} documentation.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/mod.rs10
1 files changed, 3 insertions, 7 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index 0de02cbf19c..e308a2d8e03 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -1264,15 +1264,13 @@ pub trait BufRead: Read {
     #[stable(feature = "rust1", since = "1.0.0")]
     fn consume(&mut self, amt: usize);
 
-    /// Read all bytes into `buf` until the delimiter `byte` is reached.
+    /// Read 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 this reader is currently at EOF then this function will not modify
-    /// `buf` and will return `Ok(n)` where `n` is the number of bytes which
-    /// were read.
+    /// If successful, this function will return the total number of bytes read.
     ///
     /// # Errors
     ///
@@ -1315,9 +1313,7 @@ pub trait BufRead: Read {
     /// up to, and including, the delimiter (if found) will be appended to
     /// `buf`.
     ///
-    /// If this reader is currently at EOF then this function will not modify
-    /// `buf` and will return `Ok(n)` where `n` is the number of bytes which
-    /// were read.
+    /// If successful, this function will return the total number of bytes read.
     ///
     /// # Errors
     ///