@@ -997,9 +997,9 @@ pub trait Write {
997
997
///
998
998
/// Calls to `write` are not guaranteed to block waiting for data to be
999
999
/// written, and a write which would otherwise block can be indicated through
1000
- /// an `Err` variant.
1000
+ /// an [ `Err`] variant.
1001
1001
///
1002
- /// If the return value is `Ok(n)` then it must be guaranteed that
1002
+ /// If the return value is [ `Ok(n)`] then it must be guaranteed that
1003
1003
/// `0 <= n <= buf.len()`. A return value of `0` typically means that the
1004
1004
/// underlying object is no longer able to accept bytes and will likely not
1005
1005
/// be able to in the future as well, or that the buffer provided is empty.
@@ -1013,9 +1013,13 @@ pub trait Write {
1013
1013
/// It is **not** considered an error if the entire buffer could not be
1014
1014
/// written to this writer.
1015
1015
///
1016
- /// An error of the `ErrorKind::Interrupted` kind is non-fatal and the
1016
+ /// An error of the [ `ErrorKind::Interrupted`] kind is non-fatal and the
1017
1017
/// write operation should be retried if there is nothing else to do.
1018
1018
///
1019
+ /// [`Err`]: ../../std/result/enum.Result.html#variant.Err
1020
+ /// [`Ok(n)`]: ../../std/result/enum.Result.html#variant.Ok
1021
+ /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
1022
+ ///
1019
1023
/// # Examples
1020
1024
///
1021
1025
/// ```
@@ -1061,17 +1065,20 @@ pub trait Write {
1061
1065
1062
1066
/// Attempts to write an entire buffer into this write.
1063
1067
///
1064
- /// This method will continuously call `write` until there is no more data
1065
- /// to be written or an error of non-`ErrorKind::Interrupted` kind is
1068
+ /// This method will continuously call [ `write`] until there is no more data
1069
+ /// to be written or an error of non-[ `ErrorKind::Interrupted`] kind is
1066
1070
/// returned. This method will not return until the entire buffer has been
1067
1071
/// successfully written or such an error occurs. The first error that is
1068
- /// not of `ErrorKind::Interrupted` kind generated from this method will be
1072
+ /// not of [ `ErrorKind::Interrupted`] kind generated from this method will be
1069
1073
/// returned.
1070
1074
///
1071
1075
/// # Errors
1072
1076
///
1073
1077
/// This function will return the first error of
1074
- /// non-`ErrorKind::Interrupted` kind that `write` returns.
1078
+ /// non-[`ErrorKind::Interrupted`] kind that [`write`] returns.
1079
+ ///
1080
+ /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
1081
+ /// [`write`]: #tymethod.write
1075
1082
///
1076
1083
/// # Examples
1077
1084
///
0 commit comments