Add must_use attribute to Serve (#2484)

tokio-rs · Jan 2, 2024 · cdd0ecc · cdd0ecc
1 parent af13c53
commit cdd0ecc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/axum/CHANGELOG.md b/axum/CHANGELOG.md
@@ -8,8 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 # Unreleased
 
 - **fixed:** Improve `debug_handler` on tuple response types ([#2201])
+- **added:** Add `must_use` attribute to `Serve` and `WithGracefulShutdown` ([#2484])
 
 [#2201]: https://github.com/tokio-rs/axum/pull/2201
+[#2484]: https://github.com/tokio-rs/axum/pull/2484
 
 # 0.7.3 (29. December, 2023)
 

diff --git a/axum/src/serve.rs b/axum/src/serve.rs
@@ -108,6 +108,7 @@ where
 
 /// Future returned by [`serve`].
 #[cfg(all(feature = "tokio", any(feature = "http1", feature = "http2")))]
+#[must_use = "futures must be awaited or polled"]
 pub struct Serve<M, S> {
     tcp_listener: TcpListener,
     make_service: M,
@@ -234,6 +235,7 @@ where
 
 /// Serve future with graceful shutdown enabled.
 #[cfg(all(feature = "tokio", any(feature = "http1", feature = "http2")))]
+#[must_use = "futures must be awaited or polled"]
 pub struct WithGracefulShutdown<M, S, F> {
     tcp_listener: TcpListener,
     make_service: M,