Merge #454: Fix bitreq doc example

tcharding · tcharding · commit 723faf47b1a0 · 2026-01-15T13:37:46.000+11:00
3c0c4ce Fix bitreq doc example (Jamil Lambert, PhD) Pull request description: The example in the docs cause a random CI failure. Change it so that it doesn't rely on `example.com` anymore. Add a timeout to avoid hanging. Closes #434 ACKs for top commit: tcharding: ACK 3c0c4ce Tree-SHA512: 6ac41943f5c6300f61fcb6464c617ef975f7bc5b62e9dac728b641c9ad4cafa7316a8b9c75316351fd8d94e7ebedb8a9772646b648351f6e8e60cd69fce4ab00
diff --git a/bitreq/src/lib.rs b/bitreq/src/lib.rs
@@ -89,21 +89,35 @@
 //!
 //! ## Get
 //!
-//! This is a simple example of sending a GET request and printing out
-//! the response's body, status code, and reason phrase. The `?` are
+//! This is a simple example of sending a GET request and checking the
+//! response's body, status code, and reason phrase. The `?` are
 //! needed because the server could return invalid UTF-8 in the body,
-//! or something could go wrong during the download.
+//! or something could go wrong while sending the request or receiving
+//! the response.
 //!
 //! ```
 //! # #[cfg(feature = "std")]
-//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
-//! let response = bitreq::get("http://example.com").send()?;
+//! # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
+//! # use std::thread;
+//! # use tiny_http::{Response, Server};
+//! #
+//! # let server = Server::http("127.0.0.1:0")?;
+//! # let addr = server.server_addr().to_ip().expect("IP listen addr");
+//! # let server_thread = thread::spawn(move || {
+//! #     let request = server.recv().expect("server recv");
+//! #     let response = Response::from_string("<html></html>");
+//! #     let _ = request.respond(response);
+//! # });
+//! #
+//! # let url = format!("http://{addr}/");
+//! let response = bitreq::get(&url).with_timeout(10).send()?;
 //! assert!(response.as_str()?.contains("</html>"));
 //! assert_eq!(200, response.status_code);
 //! assert_eq!("OK", response.reason_phrase);
+//! # server_thread.join().expect("server thread join");
 //! # Ok(()) }
 //! # #[cfg(not(feature = "std"))]
-//! # fn main() -> Result<(), Box<dyn std::error::Error>> { Ok(()) }
+//! # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> { Ok(()) }
 //! ```
 //!
 //! Note: you could change the `get` function to `head` or `put` or
