Add more must_use attributes (#2846)

… so people get a warning when they accidentally add a semicolon after the response expression in a handler function. Also update changelogs of axum-core, axum-extra.
tokio-rs · Sep 12, 2024 · de9290a · de9290a
1 parent 8b1cad6
commit de9290a
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 4 deletions.
diff --git a/axum-core/CHANGELOG.md b/axum-core/CHANGELOG.md
@@ -7,9 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # Unreleased
 
-- **added:** Implement `Copy` for `DefaultBodyLimit`
+- **added:** Derive `Clone` and `Copy` for `AppendHeaders` ([#2776])
+- **added:** `must_use` attribute on `AppendHeaders` ([#2846])
+- **added:** `must_use` attribute on `ErrorResponse` ([#2846])
+- **added:** `must_use` attribute on `IntoResponse::into_response` ([#2846])
+- **added:** `must_use` attribute on `IntoResponseParts` trait methods ([#2846])
+- **added:** Implement `Copy` for `DefaultBodyLimit` ([#2875])
 - **added**: `DefaultBodyLimit::max` and `DefaultBodyLimit::disable` are now
-  allowed in const context
+  allowed in const context ([#2875])
+
+[#2776]: https://github.com/tokio-rs/axum/pull/2776
+[#2846]: https://github.com/tokio-rs/axum/pull/2846
+[#2875]: https://github.com/tokio-rs/axum/pull/2875
 
 # 0.4.3 (13. January, 2024)
 

diff --git a/axum-core/src/response/into_response.rs b/axum-core/src/response/into_response.rs
@@ -111,6 +111,7 @@ use std::{
 /// ```
 pub trait IntoResponse {
     /// Create a response.
+    #[must_use]
     fn into_response(self) -> Response;
 }
 

diff --git a/axum-core/src/response/into_response_parts.rs b/axum-core/src/response/into_response_parts.rs
@@ -105,21 +105,25 @@ pub struct ResponseParts {
 
 impl ResponseParts {
     /// Gets a reference to the response headers.
+    #[must_use]
     pub fn headers(&self) -> &HeaderMap {
         self.res.headers()
     }
 
     /// Gets a mutable reference to the response headers.
+    #[must_use]
     pub fn headers_mut(&mut self) -> &mut HeaderMap {
         self.res.headers_mut()
     }
 
     /// Gets a reference to the response extensions.
+    #[must_use]
     pub fn extensions(&self) -> &Extensions {
         self.res.extensions()
     }
 
     /// Gets a mutable reference to the response extensions.
+    #[must_use]
     pub fn extensions_mut(&mut self) -> &mut Extensions {
         self.res.extensions_mut()
     }

diff --git a/axum-core/src/response/mod.rs b/axum-core/src/response/mod.rs
@@ -117,6 +117,7 @@ where
 ///
 /// See [`Result`] for more details.
 #[derive(Debug)]
+#[must_use]
 pub struct ErrorResponse(Response);
 
 impl<T> From<T> for ErrorResponse

diff --git a/axum-extra/CHANGELOG.md b/axum-extra/CHANGELOG.md
@@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning].
 
 # Unreleased
 
-- None.
+- **added:** The `response::Attachment` type ([#2789])
+
+[#2789]: https://github.com/tokio-rs/axum/pull/2789
 
 # 0.9.3 (24. March, 2024)
 

diff --git a/axum-extra/src/response/attachment.rs b/axum-extra/src/response/attachment.rs
@@ -33,8 +33,8 @@ use tracing::error;
 /// # Note
 ///
 /// If you use axum with hyper, hyper will set the `Content-Length` if it is known.
-///
 #[derive(Debug)]
+#[must_use]
 pub struct Attachment<T> {
     inner: T,
     filename: Option<HeaderValue>,