itsscb/axum
1
0
Fork 0
mirror of https://github.com/tokio-rs/axum.git synced 2025-10-02 15:24:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify required response body type when routing to tower::Services (#69)

Browse Source
This commit is contained in:
David Pedersen 2021-08-01 15:42:12 +02:00 committed by GitHub
parent 593f3e115f
commit f581e3efb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Implement `Deref` most extractors ([#56](https://github.com/tokio-rs/axum/pull/56)) - Implement `Deref` most extractors ([#56](https://github.com/tokio-rs/axum/pull/56))
- Return `405 Method Not Allowed` for unsupported method for route ([#63](https://github.com/tokio-rs/axum/pull/63)) - Return `405 Method Not Allowed` for unsupported method for route ([#63](https://github.com/tokio-rs/axum/pull/63))
- Add extractor for remote connection info ([#55](https://github.com/tokio-rs/axum/pull/55)) - Add extractor for remote connection info ([#55](https://github.com/tokio-rs/axum/pull/55))
- Clarify required response body type when routing to `tower::Service`s ([#69](https://github.com/tokio-rs/axum/pull/69))
- Add `axum::body::box_body` to converting an `http_body::Body` to `axum::body::BoxBody` ([#69](https://github.com/tokio-rs/axum/pull/69))
## Breaking changes ## Breaking changes

7
src/body.rs
View File

@ -9,11 +9,12 @@ pub use hyper::body::Body;
/// A boxed [`Body`] trait object. /// A boxed [`Body`] trait object.
/// ///
/// This is used in axum as the response body type for applications. Its necessary to unify /// This is used in axum as the response body type for applications. Its
/// multiple response bodies types into one. /// necessary to unify multiple response bodies types into one.
pub type BoxBody = http_body::combinators::BoxBody<Bytes, BoxStdError>; pub type BoxBody = http_body::combinators::BoxBody<Bytes, BoxStdError>;
pub(crate) fn box_body<B>(body: B) -> BoxBody /// Convert a [`http_body::Body`] into a [`BoxBody`].
pub fn box_body<B>(body: B) -> BoxBody
where where
B: http_body::Body<Data = Bytes> + Send + Sync + 'static, B: http_body::Body<Data = Bytes> + Send + Sync + 'static,
B::Error: Into<BoxError>, B::Error: Into<BoxError>,

13
src/lib.rs
View File

@ -487,11 +487,24 @@
//! let app = route( //! let app = route(
//! // Any request to `/` goes to a service //! // Any request to `/` goes to a service
//! "/", //! "/",
//! // Services who's response body is not `axum::body::BoxBody`
//! // can be wrapped in `axum::service::any` (or one of the other routing filters)
//! // to have the response body mapped
//! service::any(service_fn(|_: Request<Body>| async { //! service::any(service_fn(|_: Request<Body>| async {
//! let res = Response::new(Body::from("Hi from `GET /`")); //! let res = Response::new(Body::from("Hi from `GET /`"));
//! Ok(res) //! Ok(res)
//! })) //! }))
//! ).route( //! ).route(
//! "/foo",
//! // This service's response body is `axum::body::BoxBody` so
//! // it can be routed to directly.
//! service_fn(|req: Request<Body>| async move {
//! let body = Body::from(format!("Hi from `{} /foo`", req.method()));
//! let body = axum::body::box_body(body);
//! let res = Response::new(body);
//! Ok(res)
//! })
//! ).route(
//! // GET `/static/Cargo.toml` goes to a service from tower-http //! // GET `/static/Cargo.toml` goes to a service from tower-http
//! "/static/Cargo.toml", //! "/static/Cargo.toml",
//! service::get(ServeFile::new("Cargo.toml")) //! service::get(ServeFile::new("Cargo.toml"))