mirror of
https://github.com/tokio-rs/axum.git
synced 2024-11-21 14:46:32 +01:00
Add struct NoContent
as a self-described shortcut (#2978)
This commit is contained in:
parent
236781cfdc
commit
dcb4af68de
2 changed files with 36 additions and 1 deletions
|
@ -9,8 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
- **added:** Add `MethodFilter::CONNECT`, `routing::connect[_service]`
|
||||
and `MethodRouter::connect[_service]` ([#2961])
|
||||
- **added:** Add `NoContent` as a self-described shortcut for `StatusCode::NO_CONTENT` ([#2978])
|
||||
|
||||
[#2961]: https://github.com/tokio-rs/axum/pull/2961
|
||||
[#2978]: https://github.com/tokio-rs/axum/pull/2978
|
||||
|
||||
# 0.7.7
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
#![doc = include_str!("../docs/response.md")]
|
||||
|
||||
use axum_core::body::Body;
|
||||
use http::{header, HeaderValue};
|
||||
use http::{header, HeaderValue, StatusCode};
|
||||
|
||||
mod redirect;
|
||||
|
||||
|
@ -60,6 +60,31 @@ impl<T> From<T> for Html<T> {
|
|||
}
|
||||
}
|
||||
|
||||
/// An empty response with 204 No Content status.
|
||||
///
|
||||
/// Due to historical and implementation reasons, the `IntoResponse` implementation of `()`
|
||||
/// (unit type) returns an empty response with 200 [`StatusCode::OK`] status.
|
||||
/// If you specifically want a 204 [`StatusCode::NO_CONTENT`] status, you can use either `StatusCode` type
|
||||
/// directly, or this shortcut struct for self-documentation.
|
||||
///
|
||||
/// ```
|
||||
/// use axum::{extract::Path, response::NoContent};
|
||||
///
|
||||
/// async fn delete_user(Path(user): Path<String>) -> Result<NoContent, String> {
|
||||
/// // ...access database...
|
||||
/// # drop(user);
|
||||
/// Ok(NoContent)
|
||||
/// }
|
||||
/// ```
|
||||
#[derive(Debug, Clone, Copy)]
|
||||
pub struct NoContent;
|
||||
|
||||
impl IntoResponse for NoContent {
|
||||
fn into_response(self) -> Response {
|
||||
StatusCode::NO_CONTENT.into_response()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use crate::extract::Extension;
|
||||
|
@ -224,4 +249,12 @@ mod tests {
|
|||
.route("/", get(header_array_extension_body))
|
||||
.route("/", get(header_array_extension_mixed_body));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn no_content() {
|
||||
assert_eq!(
|
||||
super::NoContent.into_response().status(),
|
||||
StatusCode::NO_CONTENT,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue