Rollup merge of #102781 - StackOverflowExcept1on:master, r=joshtriplett
Improved documentation for `std::io::Error`
This commit is contained in:
commit
fbb0c31544
@ -481,6 +481,7 @@ impl Error {
|
||||
/// originate from the OS itself. The `error` argument is an arbitrary
|
||||
/// payload which will be contained in this [`Error`].
|
||||
///
|
||||
/// Note that this function allocates memory on the heap.
|
||||
/// If no extra payload is required, use the `From` conversion from
|
||||
/// `ErrorKind`.
|
||||
///
|
||||
@ -495,7 +496,7 @@ impl Error {
|
||||
/// // errors can also be created from other errors
|
||||
/// let custom_error2 = Error::new(ErrorKind::Interrupted, custom_error);
|
||||
///
|
||||
/// // creating an error without payload
|
||||
/// // creating an error without payload (and without memory allocation)
|
||||
/// let eof_error = Error::from(ErrorKind::UnexpectedEof);
|
||||
/// ```
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
|
Loading…
Reference in New Issue
Block a user