about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2015-08-19 17:29:43 +0000
committerbors <bors@rust-lang.org>2015-08-19 17:29:43 +0000
commit3a407b6c4eea5d7bff34abf42518bcb8379c0cfb (patch)
treee6896628e59c5f16d2d43715a3c0409953a16587 /src/libstd
parentaca2057ed5fb7af3f8905b2bc01f72fa001c35c8 (diff)
parent7c06c5a90015a73cdcb6cd6b6243bc99fcd9d357 (diff)
downloadrust-3a407b6c4eea5d7bff34abf42518bcb8379c0cfb.tar.gz
rust-3a407b6c4eea5d7bff34abf42518bcb8379c0cfb.zip
Auto merge of #27885 - steveklabnik:gh27637, r=alexcrichton
Hopefully make this distinction a little more clear.

Fixes #27637 
r? @alexcrichton /cc @havvy
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/error.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/libstd/io/error.rs b/src/libstd/io/error.rs
index 17a72e0f1b5..eb39a836c43 100644
--- a/src/libstd/io/error.rs
+++ b/src/libstd/io/error.rs
@@ -125,6 +125,9 @@ pub enum ErrorKind {
     /// Unlike `InvalidInput`, this typically means that the operation
     /// parameters were valid, however the error was caused by malformed
     /// input data.
+    ///
+    /// For example, a function that reads a file into a string will error with
+    /// `InvalidData` if the file's contents are not valid UTF-8.
     #[stable(feature = "io_invalid_data", since = "1.2.0")]
     InvalidData,
     /// The I/O operation's timeout expired, causing it to be canceled.