itsscb/axum
1
0
Fork 0
mirror of https://github.com/tokio-rs/axum.git synced 2025-09-27 13:00:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename box_body to body (#533)

Browse Source 
Probably would have been easier to merge this change directly into
`main` first and the backport it to `v0.3.x` but here we are :P

Fixes #528
This commit is contained in:
David Pedersen 2021-11-17 13:59:29 +01:00 committed by GitHub
parent 939995e80e
commit a317072467
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 54 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
axum-handle-error-extract/src/lib.rs
View File

@ -138,7 +138,7 @@
#![cfg_attr(test, allow(clippy::float_cmp))] #![cfg_attr(test, allow(clippy::float_cmp))]
use axum::{ use axum::{
body::{box_body, BoxBody, Bytes, Full, HttpBody}, body::{boxed, BoxBody, Bytes, Full, HttpBody},
extract::{FromRequest, RequestParts}, extract::{FromRequest, RequestParts},
http::{Request, Response, StatusCode}, http::{Request, Response, StatusCode},
response::IntoResponse, response::IntoResponse,
@ -281,8 +281,8 @@ where
let future = Box::pin(async move { let future = Box::pin(async move {
match inner.oneshot(req).await { match inner.oneshot(req).await {
Ok(res) => Ok(res.map(box_body)), Ok(res) => Ok(res.map(boxed)),
Err(err) => Ok(f(err).await.into_response().map(box_body)), Err(err) => Ok(f(err).await.into_response().map(boxed)),
} }
}); });
@ -329,7 +329,7 @@ macro_rules! impl_service {
$( $(
let $ty = match $ty::from_request(&mut req).await { let $ty = match $ty::from_request(&mut req).await {
Ok(value) => value, Ok(value) => value,
Err(rejection) => return Ok(rejection.into_response().map(box_body)), Err(rejection) => return Ok(rejection.into_response().map(boxed)),
}; };
)* )*
@ -338,14 +338,14 @@ macro_rules! impl_service {
Err(err) => { Err(err) => {
return Ok(Response::builder() return Ok(Response::builder()
.status(StatusCode::INTERNAL_SERVER_ERROR) .status(StatusCode::INTERNAL_SERVER_ERROR)
.body(box_body(Full::from(err.to_string()))) .body(boxed(Full::from(err.to_string())))
.unwrap()); .unwrap());
} }
}; };
match inner.oneshot(req).await { match inner.oneshot(req).await {
Ok(res) => Ok(res.map(box_body)), Ok(res) => Ok(res.map(boxed)),
Err(err) => Ok(f($($ty),*, err).await.into_response().map(box_body)), Err(err) => Ok(f($($ty),*, err).await.into_response().map(boxed)),
} }
}); });

2
axum/CHANGELOG.md
View File

@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
`MethodRouter::route_layer`. `MethodRouter::route_layer`.
- Merge method routers with `MethodRouter::merge` - Merge method routers with `MethodRouter::merge`
- Customize response for unsupported methods with `MethodRouter::fallback` - Customize response for unsupported methods with `MethodRouter::fallback`
- **breaking:** The previously deprecated `axum::body::box_body` function has
been removed. Use `axum::body::boxed` instead.
- **fixed:** Adding the same route with different methods now works ie - **fixed:** Adding the same route with different methods now works ie
`.route("/", get(_)).route("/", post(_))`. `.route("/", get(_)).route("/", post(_))`.
- **breaking:** `routing::handler_method_router` and - **breaking:** `routing::handler_method_router` and

4
axum/src/body/mod.rs
View File

@ -22,7 +22,7 @@ pub use bytes::Bytes;
pub type BoxBody = http_body::combinators::UnsyncBoxBody<Bytes, Error>; pub type BoxBody = http_body::combinators::UnsyncBoxBody<Bytes, Error>;
/// Convert a [`http_body::Body`] into a [`BoxBody`]. /// Convert a [`http_body::Body`] into a [`BoxBody`].
pub fn box_body<B>(body: B) -> BoxBody pub fn boxed<B>(body: B) -> BoxBody
where where
B: http_body::Body<Data = Bytes> + Send + 'static, B: http_body::Body<Data = Bytes> + Send + 'static,
B::Error: Into<BoxError>, B::Error: Into<BoxError>,
@ -31,5 +31,5 @@ where
} }
pub(crate) fn empty() -> BoxBody { pub(crate) fn empty() -> BoxBody {
box_body(http_body::Empty::new()) boxed(http_body::Empty::new())
} }

2
axum/src/docs/routing/route.md
View File

@ -137,7 +137,7 @@ let app = Router::new()
// it can be routed to directly. // it can be routed to directly.
service_fn(|req: Request<Body>| async move { service_fn(|req: Request<Body>| async move {
let body = Body::from(format!("Hi from `{} /foo`", req.method())); let body = Body::from(format!("Hi from `{} /foo`", req.method()));
let body = axum::body::box_body(body); let body = axum::body::boxed(body);
let res = Response::new(body); let res = Response::new(body);
Ok::<_, Infallible>(res) Ok::<_, Infallible>(res)
}) })

6
axum/src/error_handling/mod.rs
View File

@ -138,7 +138,7 @@ pub mod future {
//! Future types. //! Future types.
use crate::{ use crate::{
body::{box_body, BoxBody}, body::{boxed, BoxBody},
response::IntoResponse, response::IntoResponse,
BoxError, BoxError,
}; };
@ -177,11 +177,11 @@ pub mod future {
let this = self.project(); let this = self.project();
match ready!(this.inner.poll(cx)) { match ready!(this.inner.poll(cx)) {
Ok(res) => Ok(res.map(box_body)).into(), Ok(res) => Ok(res.map(boxed)).into(),
Err(err) => { Err(err) => {
let f = this.f.take().unwrap(); let f = this.f.take().unwrap();
let res = f(err); let res = f(err);
Ok(res.into_response().map(box_body)).into() Ok(res.into_response().map(boxed)).into()
} }
} }
} }

4
axum/src/extract/extractor_middleware.rs
View File

@ -247,7 +247,7 @@ where
State::Call { future } State::Call { future }
} }
Err(err) => { Err(err) => {
let res = err.into_response().map(crate::body::box_body); let res = err.into_response().map(crate::body::boxed);
return Poll::Ready(Ok(res)); return Poll::Ready(Ok(res));
} }
} }
@ -255,7 +255,7 @@ where
StateProj::Call { future } => { StateProj::Call { future } => {
return future return future
.poll(cx) .poll(cx)
.map(|result| result.map(|response| response.map(crate::body::box_body))); .map(|result| result.map(|response| response.map(crate::body::boxed)));
} }
}; };

10
axum/src/extract/rejection.rs
View File

@ -2,7 +2,7 @@
use super::IntoResponse; use super::IntoResponse;
use crate::{ use crate::{
body::{box_body, BoxBody}, body::{boxed, BoxBody},
BoxError, Error, BoxError, Error,
}; };
use bytes::Bytes; use bytes::Bytes;
@ -325,10 +325,10 @@ where
fn into_response(self) -> http::Response<Self::Body> { fn into_response(self) -> http::Response<Self::Body> {
match self { match self {
Self::PayloadTooLarge(inner) => inner.into_response().map(box_body), Self::PayloadTooLarge(inner) => inner.into_response().map(boxed),
Self::LengthRequired(inner) => inner.into_response().map(box_body), Self::LengthRequired(inner) => inner.into_response().map(boxed),
Self::HeadersAlreadyExtracted(inner) => inner.into_response().map(box_body), Self::HeadersAlreadyExtracted(inner) => inner.into_response().map(boxed),
Self::Inner(inner) => inner.into_response().map(box_body), Self::Inner(inner) => inner.into_response().map(boxed),
} }
} }
} }

4
axum/src/extract/tuple.rs
View File

@ -1,6 +1,6 @@
use super::{FromRequest, RequestParts}; use super::{FromRequest, RequestParts};
use crate::{ use crate::{
body::{box_body, BoxBody}, body::{boxed, BoxBody},
response::IntoResponse, response::IntoResponse,
}; };
use async_trait::async_trait; use async_trait::async_trait;
@ -33,7 +33,7 @@ macro_rules! impl_from_request {
type Rejection = Response<BoxBody>; type Rejection = Response<BoxBody>;
async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> { async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
$( let $ty = $ty::from_request(req).await.map_err(|err| err.into_response().map(box_body))?; )* $( let $ty = $ty::from_request(req).await.map_err(|err| err.into_response().map(boxed))?; )*
Ok(($($ty,)*)) Ok(($($ty,)*))
} }
} }

12
axum/src/handler/mod.rs
View File

@ -71,7 +71,7 @@
//! [axum-debug]: https://docs.rs/axum-debug //! [axum-debug]: https://docs.rs/axum-debug
use crate::{ use crate::{
body::{box_body, Body, BoxBody}, body::{boxed, Body, BoxBody},
extract::{ extract::{
connect_info::{Connected, IntoMakeServiceWithConnectInfo}, connect_info::{Connected, IntoMakeServiceWithConnectInfo},
FromRequest, RequestParts, FromRequest, RequestParts,
@ -272,7 +272,7 @@ where
type Sealed = sealed::Hidden; type Sealed = sealed::Hidden;
async fn call(self, _req: Request<B>) -> Response<BoxBody> { async fn call(self, _req: Request<B>) -> Response<BoxBody> {
self().await.into_response().map(box_body) self().await.into_response().map(boxed)
} }
} }
@ -296,13 +296,13 @@ macro_rules! impl_handler {
$( $(
let $ty = match $ty::from_request(&mut req).await { let $ty = match $ty::from_request(&mut req).await {
Ok(value) => value, Ok(value) => value,
Err(rejection) => return rejection.into_response().map(box_body), Err(rejection) => return rejection.into_response().map(boxed),
}; };
)* )*
let res = self($($ty,)*).await; let res = self($($ty,)*).await;
res.into_response().map(box_body) res.into_response().map(boxed)
} }
} }
}; };
@ -371,8 +371,8 @@ where
.await .await
.map_err(IntoResponse::into_response) .map_err(IntoResponse::into_response)
{ {
Ok(res) => res.map(box_body), Ok(res) => res.map(boxed),
Err(res) => res.map(box_body), Err(res) => res.map(boxed),
} }
} }
} }

10
axum/src/response/headers.rs
View File

@ -1,6 +1,6 @@
use super::IntoResponse; use super::IntoResponse;
use crate::{ use crate::{
body::{box_body, BoxBody}, body::{boxed, BoxBody},
BoxError, BoxError,
}; };
use bytes::Bytes; use bytes::Bytes;
@ -133,10 +133,10 @@ where
fn into_response(self) -> Response<Self::Body> { fn into_response(self) -> Response<Self::Body> {
let headers = match self.0.try_into_header_map() { let headers = match self.0.try_into_header_map() {
Ok(headers) => headers, Ok(headers) => headers,
Err(res) => return res.map(box_body), Err(res) => return res.map(boxed),
}; };
(headers, self.1).into_response().map(box_body) (headers, self.1).into_response().map(boxed)
} }
} }
@ -157,10 +157,10 @@ where
fn into_response(self) -> Response<Self::Body> { fn into_response(self) -> Response<Self::Body> {
let headers = match self.1.try_into_header_map() { let headers = match self.1.try_into_header_map() {
Ok(headers) => headers, Ok(headers) => headers,
Err(res) => return res.map(box_body), Err(res) => return res.map(boxed),
}; };
(self.0, headers, self.2).into_response().map(box_body) (self.0, headers, self.2).into_response().map(boxed)
} }
} }

8
axum/src/response/mod.rs
View File

@ -1,7 +1,7 @@
#![doc = include_str!("../docs/response.md")] #![doc = include_str!("../docs/response.md")]
use crate::{ use crate::{
body::{box_body, BoxBody}, body::{boxed, BoxBody},
BoxError, Error, BoxError, Error,
}; };
use bytes::Bytes; use bytes::Bytes;
@ -157,7 +157,7 @@ pub trait IntoResponse {
/// contains exactly one chunk. /// contains exactly one chunk.
/// - [`axum::body::BoxBody`]: If you need to unify multiple body types into /// - [`axum::body::BoxBody`]: If you need to unify multiple body types into
/// one, or return a body type that cannot be named. Can be created with /// one, or return a body type that cannot be named. Can be created with
/// [`box_body`]. /// [`boxed`].
/// ///
/// [`axum::body::Body`]: crate::body::Body /// [`axum::body::Body`]: crate::body::Body
/// [`axum::body::Empty<Bytes>`]: crate::body::Empty /// [`axum::body::Empty<Bytes>`]: crate::body::Empty
@ -209,8 +209,8 @@ where
fn into_response(self) -> Response<Self::Body> { fn into_response(self) -> Response<Self::Body> {
match self { match self {
Ok(value) => value.into_response().map(box_body), Ok(value) => value.into_response().map(boxed),
Err(err) => err.into_response().map(box_body), Err(err) => err.into_response().map(boxed),
} }
} }
} }

12
axum/src/routing/method_routing.rs
View File

@ -1,5 +1,5 @@
use crate::{ use crate::{
body::{box_body, Body, BoxBody, Bytes}, body::{boxed, Body, BoxBody, Bytes},
error_handling::HandleErrorLayer, error_handling::HandleErrorLayer,
handler::Handler, handler::Handler,
http::{Method, Request, Response, StatusCode}, http::{Method, Request, Response, StatusCode},
@ -508,7 +508,7 @@ impl<B, E> MethodRouter<B, E> {
/// requests. /// requests.
pub fn new() -> Self { pub fn new() -> Self {
let fallback = Route::new(service_fn(|_: Request<B>| async { let fallback = Route::new(service_fn(|_: Request<B>| async {
let mut response = Response::new(box_body(Empty::new())); let mut response = Response::new(boxed(Empty::new()));
*response.status_mut() = StatusCode::METHOD_NOT_ALLOWED; *response.status_mut() = StatusCode::METHOD_NOT_ALLOWED;
Ok(response) Ok(response)
})); }));
@ -609,7 +609,7 @@ impl<ReqBody, E> MethodRouter<ReqBody, E> {
ResBody: http_body::Body<Data = Bytes> + Send + 'static, ResBody: http_body::Body<Data = Bytes> + Send + 'static,
ResBody::Error: Into<BoxError>, ResBody::Error: Into<BoxError>,
{ {
self.on_service_boxed_response_body(filter, svc.map_response(|res| res.map(box_body))) self.on_service_boxed_response_body(filter, svc.map_response(|res| res.map(boxed)))
} }
chained_service_fn!(delete_service, DELETE); chained_service_fn!(delete_service, DELETE);
@ -632,7 +632,7 @@ impl<ReqBody, E> MethodRouter<ReqBody, E> {
ResBody: http_body::Body<Data = Bytes> + Send + 'static, ResBody: http_body::Body<Data = Bytes> + Send + 'static,
ResBody::Error: Into<BoxError>, ResBody::Error: Into<BoxError>,
{ {
self.fallback = Fallback::Custom(Route::new(svc.map_response(|res| res.map(box_body)))); self.fallback = Fallback::Custom(Route::new(svc.map_response(|res| res.map(boxed))));
self self
} }
@ -665,7 +665,7 @@ impl<ReqBody, E> MethodRouter<ReqBody, E> {
{ {
let layer = ServiceBuilder::new() let layer = ServiceBuilder::new()
.layer_fn(Route::new) .layer_fn(Route::new)
.layer(MapResponseBodyLayer::new(box_body)) .layer(MapResponseBodyLayer::new(boxed))
.layer(layer) .layer(layer)
.into_inner(); .into_inner();
let layer_fn = |s| layer.layer(s); let layer_fn = |s| layer.layer(s);
@ -698,7 +698,7 @@ impl<ReqBody, E> MethodRouter<ReqBody, E> {
{ {
let layer = ServiceBuilder::new() let layer = ServiceBuilder::new()
.layer_fn(Route::new) .layer_fn(Route::new)
.layer(MapResponseBodyLayer::new(box_body)) .layer(MapResponseBodyLayer::new(boxed))
.layer(layer) .layer(layer)
.into_inner(); .into_inner();
let layer_fn = |s| layer.layer(s); let layer_fn = |s| layer.layer(s);

6
axum/src/routing/mod.rs
View File

@ -2,7 +2,7 @@
use self::{future::RouterFuture, not_found::NotFound}; use self::{future::RouterFuture, not_found::NotFound};
use crate::{ use crate::{
body::{box_body, Body, BoxBody}, body::{boxed, Body, BoxBody},
extract::{ extract::{
connect_info::{Connected, IntoMakeServiceWithConnectInfo}, connect_info::{Connected, IntoMakeServiceWithConnectInfo},
MatchedPath, OriginalUri, MatchedPath, OriginalUri,
@ -274,7 +274,7 @@ where
NewResBody::Error: Into<BoxError>, NewResBody::Error: Into<BoxError>,
{ {
let layer = ServiceBuilder::new() let layer = ServiceBuilder::new()
.layer(MapResponseBodyLayer::new(box_body)) .layer(MapResponseBodyLayer::new(boxed))
.layer(layer) .layer(layer)
.into_inner(); .into_inner();
@ -315,7 +315,7 @@ where
NewResBody::Error: Into<BoxError>, NewResBody::Error: Into<BoxError>,
{ {
let layer = ServiceBuilder::new() let layer = ServiceBuilder::new()
.layer(MapResponseBodyLayer::new(box_body)) .layer(MapResponseBodyLayer::new(boxed))
.layer(layer) .layer(layer)
.into_inner(); .into_inner();

4
axum/src/routing/route.rs
View File

@ -1,5 +1,5 @@
use crate::{ use crate::{
body::{box_body, Body, BoxBody}, body::{boxed, Body, BoxBody},
clone_box_service::CloneBoxService, clone_box_service::CloneBoxService,
}; };
use http::{Request, Response}; use http::{Request, Response};
@ -99,7 +99,7 @@ impl<B, E> Future for RouteFuture<B, E> {
match self.project().future.poll(cx) { match self.project().future.poll(cx) {
Poll::Ready(Ok(res)) => { Poll::Ready(Ok(res)) => {
if strip_body { if strip_body {
Poll::Ready(Ok(res.map(|_| box_body(Empty::new())))) Poll::Ready(Ok(res.map(|_| boxed(Empty::new()))))
} else { } else {
Poll::Ready(Ok(res)) Poll::Ready(Ok(res))
} }

4
axum/src/routing/tests/nest.rs
View File

@ -1,7 +1,7 @@
use tower_http::services::ServeDir; use tower_http::services::ServeDir;
use super::*; use super::*;
use crate::{body::box_body, extract::Extension}; use crate::{body::boxed, extract::Extension};
use std::collections::HashMap; use std::collections::HashMap;
#[tokio::test] #[tokio::test]
@ -151,7 +151,7 @@ async fn nested_service_sees_stripped_uri() {
Router::new().route( Router::new().route(
"/baz", "/baz",
service_fn(|req: Request<Body>| async move { service_fn(|req: Request<Body>| async move {
let body = box_body(Body::from(req.uri().to_string())); let body = boxed(Body::from(req.uri().to_string()));
Ok::<_, Infallible>(Response::new(body)) Ok::<_, Infallible>(Response::new(body))
}), }),
), ),

4
examples/http-proxy/src/main.rs
View File

@ -13,7 +13,7 @@
//! Example is based on <https://github.com/hyperium/hyper/blob/master/examples/http_proxy.rs> //! Example is based on <https://github.com/hyperium/hyper/blob/master/examples/http_proxy.rs>
use axum::{ use axum::{
body::{box_body, Body}, body::{boxed, Body},
http::{Method, Request, Response, StatusCode}, http::{Method, Request, Response, StatusCode},
routing::get, routing::get,
Router, Router,
@ -37,7 +37,7 @@ async fn main() {
let router = router.clone(); let router = router.clone();
async move { async move {
if req.method() == Method::CONNECT { if req.method() == Method::CONNECT {
proxy(req).await.map(|res| res.map(box_body)) proxy(req).await.map(|res| res.map(boxed))
} else { } else {
router.oneshot(req).await.map_err(|err| match err {}) router.oneshot(req).await.map_err(|err| match err {})
} }