File tree 1 file changed +5
-1
lines changed 1 file changed +5
-1
lines changed Original file line number Diff line number Diff line change 87
87
H2 ( #[ pin] proto:: h2:: ClientTask < B > , PhantomData < fn ( T ) > ) ,
88
88
}
89
89
90
- /// Returns a handshake future over some IO.
90
+ /// Returns a handshake future over some IO. The io parameter will usually be a
91
+ /// [tokio::net::TcpStream](https://docs.rs/tokio/1.6.1/tokio/net/struct.TcpStream.html).
91
92
///
92
93
/// This is a shortcut for `Builder::new().handshake(io)`.
93
94
pub async fn handshake < T > (
@@ -106,6 +107,9 @@ pub struct SendRequest<B> {
106
107
107
108
/// A future that processes all HTTP state for the IO object.
108
109
///
110
+ /// The io parameter will usually be a
111
+ /// [tokio::net::TcpStream](https://docs.rs/tokio/1.6.1/tokio/net/struct.TcpStream.html).
112
+ ///
109
113
/// In most cases, this should just be spawned into an executor, so that it
110
114
/// can process incoming and outgoing messages, notice hangups, and the like.
111
115
#[ must_use = "futures do nothing unless polled" ]
You can’t perform that action at this time.
0 commit comments