@@ -43,17 +43,30 @@ mod test;
43
43
#[ derive( Copy , Clone , PartialEq , Eq , Debug ) ]
44
44
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
45
45
pub enum Shutdown {
46
- /// Indicates that the reading portion of this stream/socket should be shut
47
- /// down. All currently blocked and future reads will return `Ok(0)`.
46
+ /// The reading portion of the [`TcpStream`] should be shut down.
47
+ ///
48
+ /// All currently blocked and future [reads] will return [`Ok(0)`].
49
+ ///
50
+ /// [`TcpStream`]: ../../std/net/struct.TcpStream.html
51
+ /// [reads]: ../../std/io/trait.Read.html
52
+ /// [`Ok(0)`]: ../../std/result/enum.Result.html#variant.Ok
48
53
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
49
54
Read ,
50
- /// Indicates that the writing portion of this stream/socket should be shut
51
- /// down. All currently blocked and future writes will return an error.
55
+ /// The writing portion of the [`TcpStream`] should be shut down.
56
+ ///
57
+ /// All currently blocked and future [writes] will return an error.
58
+ ///
59
+ /// [`TcpStream`]: ../../std/net/struct.TcpStream.html
60
+ /// [writes]: ../../std/io/trait.Write.html
52
61
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
53
62
Write ,
54
- /// Shut down both the reading and writing portions of this stream.
63
+ /// Both the reading and the writing portions of the [`TcpStream`] should be shut down.
64
+ ///
65
+ /// See [`Shutdown::Read`] and [`Shutdown::Write`] for more information.
55
66
///
56
- /// See `Shutdown::Read` and `Shutdown::Write` for more information.
67
+ /// [`TcpStream`]: ../../std/net/struct.TcpStream.html
68
+ /// [`Shutdown::Read`]: #variant.Read
69
+ /// [`Shutdown::Write`]: #variant.Write
57
70
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
58
71
Both ,
59
72
}
0 commit comments