about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorMatt Brubeck <mbrubeck@limpet.net>2017-10-31 12:30:15 -0700
committerMatt Brubeck <mbrubeck@limpet.net>2017-10-31 12:30:15 -0700
commit351f7b02de15b76f00e4d6335dfda1cd90560fb9 (patch)
tree44a89f025755ea744d3ab7a0711e7522ce6b6148 /src/libstd
parent8b22e70b2de5152db3b0c53cfa16eb96b0b9e40e (diff)
downloadrust-351f7b02de15b76f00e4d6335dfda1cd90560fb9.tar.gz
rust-351f7b02de15b76f00e4d6335dfda1cd90560fb9.zip
Fix incorrect error type in Read::byte docs
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/mod.rs9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index 074ab3ebd8f..fd615d14941 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -736,10 +736,10 @@ pub trait Read {
 
     /// Transforms this `Read` instance to an [`Iterator`] over its bytes.
     ///
-    /// The returned type implements [`Iterator`] where the `Item` is [`Result`]`<`[`u8`]`,
-    /// R::Err>`. The yielded item is [`Ok`] if a byte was successfully read and
-    /// [`Err`] otherwise for I/O errors. EOF is mapped to returning [`None`] from
-    /// this iterator.
+    /// The returned type implements [`Iterator`] where the `Item` is
+    /// [`Result`]`<`[`u8`]`, `[`io::Error`]>`.
+    /// The yielded item is [`Ok`] if a byte was successfully read and [`Err`]
+    /// otherwise. EOF is mapped to returning [`None`] from this iterator.
     ///
     /// # Examples
     ///
@@ -748,6 +748,7 @@ pub trait Read {
     /// [file]: ../fs/struct.File.html
     /// [`Iterator`]: ../../std/iter/trait.Iterator.html
     /// [`Result`]: ../../std/result/enum.Result.html
+    /// [`io::Error``]: ../../std/io/struct.Error.html
     /// [`u8`]: ../../std/primitive.u8.html
     /// [`Ok`]: ../../std/result/enum.Result.html#variant.Ok
     /// [`Err`]: ../../std/result/enum.Result.html#variant.Err