Merge branch 'master' into body-stream

Author: amousset

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install rust
         uses: dtolnay/rust-toolchain@stable
@@ -61,7 +61,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install rust
         uses: dtolnay/rust-toolchain@master
@@ -81,10 +81,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust
         uses: dtolnay/rust-toolchain@nightly
 
+      # check for missing docs
+      - name: cargo check
+        run: cargo check --all-features
+        env:
+          RUSTFLAGS: "--cfg docsrs"
+
       - name: cargo doc
         run: cargo rustdoc --all-features -- -D 'rustdoc::broken_intra_doc_links'
+        env:
+          RUSTFLAGS: "--cfg docsrs"

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+### v0.4.1 (August 6, 2025)
+
+- **Fixes**:
+  - Fix `Server::graceful()` bounds incorrect requiring the filter to be a future.
+  - Enable `tokio/net` when the `server` feature is enabled.
+  - Render `cfg`s in the docs.
+
 ## v0.4.0 (August 5, 2025)
 
 - **Changes**:

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "warp"
-version = "0.4.0"
+version = "0.4.1"
 description = "serve the web at warp speeds"
 authors = ["Sean McArthur <[email protected]>"]
 license = "MIT"
@@ -29,9 +29,9 @@ futures-util = { version = "0.3", default-features = false, features = ["sink"]
 futures-channel = { version = "0.3.17", features = ["sink"]}
 headers = "0.4"
 http = "1"
-http-body-util = "0.1"
+http-body-util = "0.1.2"
 hyper = { version = "1", features = ["server", "http1", "http2"] }
-hyper-util = { version = "0.1", features = ["server", "server-graceful", "server-auto", "http1", "http2", "service", "tokio"], optional = true }
+hyper-util = { version = "0.1.12", features = ["server", "server-graceful", "server-auto", "http1", "http2", "service", "tokio"], optional = true }
 log = "0.4"
 mime = "0.3"
 mime_guess = "2.0.0"
@@ -63,7 +63,7 @@ tokio-stream = { version = "0.1.1", features = ["net"] }
 default = []
 multipart = ["dep:multer"]
 websocket = ["hyper/client", "hyper/http1", "dep:tokio-tungstenite", "hyper-util/tokio"]
-server = ["hyper/server", "hyper/http1", "hyper/http2", "dep:hyper-util"]
+server = ["hyper/server", "hyper/http1", "hyper/http2", "dep:hyper-util", "tokio/net"]
 test = ["server"]
 # tls might come back, uncertain
 #tls = ["tokio-rustls", "rustls-pemfile"]

src/lib.rs

@@ -2,7 +2,7 @@
 #![deny(missing_debug_implementations)]
 #![deny(rust_2018_idioms)]
 #![cfg_attr(test, deny(warnings))]
-#![cfg_attr(docsrs, feature(auto_doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 
 //! # warp
 //!

src/server.rs

@@ -28,6 +28,8 @@ where
 
 /// A warp Server ready to filter requests.
 ///
+/// Construct this type using [`serve()`].
+///
 /// # Unnameable
 ///
 /// This type is publicly available in the docs only.
@@ -102,9 +104,25 @@ where
     #[cfg(feature = "tls")]
     pub fn tls(self) -> Server<F, accept::Tls<A>, R> {}
 
+    /// Add graceful shutdown support to this server.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # async fn ex(addr: std::net::SocketAddr) {
+    /// # use warp::Filter;
+    /// # let filter = warp::any().map(|| "ok");
+    /// warp::serve(filter)
+    ///     .bind(addr).await
+    ///     .graceful(async {
+    ///         // some signal in here, such as ctrl_c
+    ///     })
+    ///     .run().await;
+    /// # }
+    /// ```
     pub fn graceful<Fut>(self, shutdown_signal: Fut) -> Server<F, A, run::Graceful<Fut>>
     where
-        F: Future<Output = ()> + Send + 'static,
+        Fut: Future<Output = ()> + Send + 'static,
     {
         Server {
             acceptor: self.acceptor,