Skip to content

Commit

Permalink
docs(client): replace example on mod page with link to guide
Browse files Browse the repository at this point in the history
  • Loading branch information
seanmonstar committed Jun 21, 2024
1 parent 7cedc13 commit aa7ff60
Showing 1 changed file with 4 additions and 46 deletions.
50 changes: 4 additions & 46 deletions src/client/conn/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,56 +5,14 @@
//! are not handled at this level. This module provides the building blocks to
//! customize those things externally.
//!
//! If you are looking for a convenient HTTP client,
//! then you may wish to consider [reqwest](https://github.com/seanmonstar/reqwest)
//! for a high level client or [`hyper-util`'s client](https://docs.rs/hyper-util/latest/hyper_util/client/index.html)
//! If you are looking for a convenient HTTP client, then you may wish to
//! consider [reqwest](https://github.com/seanmonstar/reqwest) for a high level
//! client or [`hyper-util`'s client](https://docs.rs/hyper-util/latest/hyper_util/client/index.html)
//! if you want to keep it more low level / basic.
//!
//! ## Example
//!
//! A simple example that uses the `SendRequest` struct to talk HTTP over some TCP stream.
//!
//! ```no_run
//! # #[cfg(all(feature = "client", feature = "http1"))]
//! # mod rt {
//! use bytes::Bytes;
//! use http::{Request, StatusCode};
//! use http_body_util::Empty;
//! use hyper::client::conn;
//! # use hyper::rt::{Read, Write};
//! # async fn run<I>(tcp: I) -> Result<(), Box<dyn std::error::Error>>
//! # where
//! # I: Read + Write + Unpin + Send + 'static,
//! # {
//! let (mut request_sender, connection) = conn::http1::handshake(tcp).await?;
//!
//! // spawn a task to poll the connection and drive the HTTP state
//! tokio::spawn(async move {
//! if let Err(e) = connection.await {
//! eprintln!("Error in connection: {}", e);
//! }
//! });
//!
//! let request = Request::builder()
//! // We need to manually add the host header because SendRequest does not
//! .header("Host", "example.com")
//! .method("GET")
//! .body(Empty::<Bytes>::new())?;
//!
//! let response = request_sender.send_request(request).await?;
//! assert!(response.status() == StatusCode::OK);
//!
//! let request = Request::builder()
//! .header("Host", "example.com")
//! .method("GET")
//! .body(Empty::<Bytes>::new())?;
//!
//! let response = request_sender.send_request(request).await?;
//! assert!(response.status() == StatusCode::OK);
//! # Ok(())
//! # }
//! # }
//! ```
//! See the [client guide](https://hyper.rs/guides/1/client/basic/).

#[cfg(feature = "http1")]
pub mod http1;
Expand Down

0 comments on commit aa7ff60

Please sign in to comment.