Add note about spawn_blocking to docs

ramosbugs · Feb 28, 2024 · 1fc8188 · 1fc8188
1 parent a7ea5c9
commit 1fc8188
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -20,6 +20,11 @@
 //!
 //! This library offers a flexible HTTP client interface with two modes:
 //!  * **Synchronous (blocking)**
+//!
+//!    NOTE: Be careful not to use a blocking HTTP client within `async` Rust code, which may panic
+//!    or cause other issues. The
+//!    [`tokio::task::spawn_blocking`](https://docs.rs/tokio/latest/tokio/task/fn.spawn_blocking.html)
+//!    function may be useful in this situation.
 //!  * **Asynchronous**
 //!
 //! ## Security Warning