Additional Documentation of IntoClientRequest on connect_async (#…

…342)

src/async_std.rs

@@ -221,6 +221,24 @@ where
 pub type ConnectStream = ClientStream<TcpStream>;
 
 /// Connect to a given URL.
+///
+/// Accepts any request that implements [`IntoClientRequest`], which is often just `&str`, but can
+/// be a variety of types such as `httparse::Request` or [`tungstenite::http::Request`] for more
+/// complex uses.
+///
+/// ```no_run
+/// # use tungstenite::client::IntoClientRequest;
+///
+/// # async fn test() {
+/// use tungstenite::http::{Method, Request};
+/// use async_tungstenite::async_std::connect_async;
+///
+/// let mut request = "wss://api.example.com".into_client_request().unwrap();
+/// request.headers_mut().insert("api-key", "42".parse().unwrap());
+///
+/// let (stream, response) = connect_async(request).await.unwrap();
+/// # }
+/// ```
 pub async fn connect_async<R>(
     request: R,
 ) -> Result<(WebSocketStream<ConnectStream>, Response), Error>

src/gio.rs

@@ -18,6 +18,24 @@ use crate::{client_async_with_config, domain, port, Response, WebSocketConfig, W
 pub type ConnectStream = IOStreamAsyncReadWrite<gio::SocketConnection>;
 
 /// Connect to a given URL.
+///
+/// Accepts any request that implements [`IntoClientRequest`], which is often just `&str`, but can
+/// be a variety of types such as `httparse::Request` or [`tungstenite::http::Request`] for more
+/// complex uses.
+///
+/// ```no_run
+/// # use tungstenite::client::IntoClientRequest;
+///
+/// # async fn test() {
+/// use tungstenite::http::{Method, Request};
+/// use async_tungstenite::gio::connect_async;
+///
+/// let mut request = "wss://api.example.com".into_client_request().unwrap();
+/// request.headers_mut().insert("api-key", "42".parse().unwrap());
+///
+/// let (stream, response) = connect_async(request).await.unwrap();
+/// # }
+/// ```
 pub async fn connect_async<R>(
     request: R,
 ) -> Result<(WebSocketStream<ConnectStream>, Response), Error>

src/tokio.rs

@@ -362,6 +362,24 @@ where
 pub type ConnectStream = ClientStream<TcpStream>;
 
 /// Connect to a given URL.
+///
+/// Accepts any request that implements [`IntoClientRequest`], which is often just `&str`, but can
+/// be a variety of types such as `httparse::Request` or [`tungstenite::http::Request`] for more
+/// complex uses.
+///
+/// ```no_run
+/// # use tungstenite::client::IntoClientRequest;
+///
+/// # async fn test() {
+/// use tungstenite::http::{Method, Request};
+/// use async_tungstenite::tokio::connect_async;
+///
+/// let mut request = "wss://api.example.com".into_client_request().unwrap();
+/// request.headers_mut().insert("api-key", "42".parse().unwrap());
+///
+/// let (stream, response) = connect_async(request).await.unwrap();
+/// # }
+/// ```
 pub async fn connect_async<R>(
     request: R,
 ) -> Result<(WebSocketStream<ConnectStream>, Response), Error>