diff --git a/src/client/conn.rs b/src/client/conn.rs index 70c1dad248..63bd21ba99 100644 --- a/src/client/conn.rs +++ b/src/client/conn.rs @@ -89,6 +89,9 @@ where /// Returns a handshake future over some IO. /// +/// The io parameter will usually be a +/// [tokio::net::TcpStream](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html). +/// /// This is a shortcut for `Builder::new().handshake(io)`. pub async fn handshake( io: T, @@ -106,6 +109,9 @@ pub struct SendRequest { /// A future that processes all HTTP state for the IO object. /// +/// The io parameter will usually be a +/// [tokio::net::TcpStream](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html). +/// /// In most cases, this should just be spawned into an executor, so that it /// can process incoming and outgoing messages, notice hangups, and the like. #[must_use = "futures do nothing unless polled"]