Skip to content

Commit

Permalink
Rollup merge of rust-lang#27164 - steveklabnik:doc_io_utils, r=alexcr…
Browse files Browse the repository at this point in the history
…ichton

These provide various special readers, so point their docs to their
constructor functions in a manner consistent with everything else.

r? @alexcrichton
  • Loading branch information
steveklabnik committed Jul 21, 2015
2 parents 2b287c1 + 7e7ec6b commit c0f0ae2
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion src/libstd/io/util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ pub fn copy<R: Read, W: Write>(reader: &mut R, writer: &mut W) -> io::Result<u64
}

/// A reader which is always at EOF.
///
/// This struct is generally created by calling [`empty()`][empty]. Please see
/// the documentation of `empty()` for more details.
///
/// [empty]: fn.empty.html
#[stable(feature = "rust1", since = "1.0.0")]
pub struct Empty { _priv: () }

Expand Down Expand Up @@ -95,7 +100,12 @@ impl BufRead for Empty {
fn consume(&mut self, _n: usize) {}
}

/// A reader which infinitely yields one byte.
/// A reader which yields one byte over and over and over and over and over and...
///
/// This struct is generally created by calling [`repeat()`][repeat]. Please
/// see the documentation of `repeat()` for more details.
///
/// [empty]: fn.repeat.html
#[stable(feature = "rust1", since = "1.0.0")]
pub struct Repeat { byte: u8 }

Expand All @@ -117,6 +127,11 @@ impl Read for Repeat {
}

/// A writer which will move data into the void.
///
/// This struct is generally created by calling [`sink()`][sink]. Please
/// see the documentation of `sink()` for more details.
///
/// [empty]: fn.sink.html
#[stable(feature = "rust1", since = "1.0.0")]
pub struct Sink { _priv: () }

Expand Down

0 comments on commit c0f0ae2

Please sign in to comment.