diff options
| author | bors <bors@rust-lang.org> | 2016-10-19 17:41:49 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-19 17:41:49 -0700 |
| commit | dfd98ebd3e862d6fe23519fc6605d03a1c146914 (patch) | |
| tree | c55534ab1c084f6aa36529c6b28c316c4f79e35f /src/libstd | |
| parent | d337f345ca8b3bb4aac988ace1c0676abc5310a0 (diff) | |
| parent | dd3a014ed9e61ba9d2f86e00ef299edf285e276c (diff) | |
| download | rust-dfd98ebd3e862d6fe23519fc6605d03a1c146914.tar.gz rust-dfd98ebd3e862d6fe23519fc6605d03a1c146914.zip | |
Auto merge of #37289 - GuillaumeGomez:rollup, r=GuillaumeGomez
Rollup of 7 pull requests - Successful merges: #37165, #37187, #37241, #37283, #37285, #37287, #37288 - Failed merges:
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/io/cursor.rs | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/src/libstd/io/cursor.rs b/src/libstd/io/cursor.rs index ae0085f1044..ca9452ffe3e 100644 --- a/src/libstd/io/cursor.rs +++ b/src/libstd/io/cursor.rs @@ -15,22 +15,28 @@ use cmp; use io::{self, SeekFrom, Error, ErrorKind}; /// A `Cursor` wraps another type and provides it with a -/// [`Seek`](trait.Seek.html) implementation. +/// [`Seek`] implementation. /// -/// Cursors are typically used with in-memory buffers to allow them to -/// implement `Read` and/or `Write`, allowing these buffers to be used +/// `Cursor`s are typically used with in-memory buffers to allow them to +/// implement [`Read`] and/or [`Write`], allowing these buffers to be used /// anywhere you might use a reader or writer that does actual I/O. /// /// The standard library implements some I/O traits on various types which -/// are commonly used as a buffer, like `Cursor<Vec<u8>>` and `Cursor<&[u8]>`. +/// are commonly used as a buffer, like `Cursor<`[`Vec`]`<u8>>` and +/// `Cursor<`[`&[u8]`]`>`. /// /// # Examples /// -/// We may want to write bytes to a [`File`][file] in our production +/// We may want to write bytes to a [`File`] in our production /// code, but use an in-memory buffer in our tests. We can do this with /// `Cursor`: /// -/// [file]: ../fs/struct.File.html +/// [`Seek`]: trait.Seek.html +/// [`Read`]: ../../std/io/trait.Read.html +/// [`Write`]: ../../std/io/trait.Write.html +/// [`Vec`]: ../../std/vec/struct.Vec.html +/// [`&[u8]`]: ../../std/primitive.slice.html +/// [`File`]: ../fs/struct.File.html /// /// ```no_run /// use std::io::prelude::*; |
