about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-08-18 13:53:32 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-08-19 10:22:18 -0400
commit7c06c5a90015a73cdcb6cd6b6243bc99fcd9d357 (patch)
treef3508ec5c97a780833e794c69abe8b1eb0929b03
parentc6291e04cc620ce3824d8bccdb8a5bd923fcd741 (diff)
downloadrust-7c06c5a90015a73cdcb6cd6b6243bc99fcd9d357.tar.gz
rust-7c06c5a90015a73cdcb6cd6b6243bc99fcd9d357.zip
Improve std::io::ErrorKind
Hopefully make this distinction a little more clear.

Fixes #27637
-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.