diff options
| author | kennytm <kennytm@gmail.com> | 2017-11-01 13:32:20 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-11-01 13:32:20 +0800 |
| commit | e2554b36fc805c5dcb8bef65fee12e0753d5ad03 (patch) | |
| tree | 651fa496e2ecb485f0cc14c222f6e76067d8e9c5 /src/libstd | |
| parent | 0ec40c1704a16c6d491dc747573f71fabbe79ed2 (diff) | |
| parent | 351f7b02de15b76f00e4d6335dfda1cd90560fb9 (diff) | |
| download | rust-e2554b36fc805c5dcb8bef65fee12e0753d5ad03.tar.gz rust-e2554b36fc805c5dcb8bef65fee12e0753d5ad03.zip | |
Rollup merge of #45664 - mbrubeck:docs, r=estebank
Fix incorrect error type in Read::byte docs None
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/io/mod.rs | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index e262257077b..dec281212a5 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 |
