Improve std::io::ErrorKind

Hopefully make this distinction a little more clear.

Fixes #27637

diff --git a/src/libstd/io/error.rs b/src/libstd/io/error.rs
index 17a72e0f1b5e5b7d00321cf88c6a8856e74d3718..eb39a836c439a7ac7d4698f534b2d43041cdc3ca 100644 (file)
--- 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.