//! Async functions that can be used to handle requests. use crate::{ body::{box_body, BoxBody}, extract::{FromRequest, RequestParts}, response::IntoResponse, routing::{MethodNotAllowed, MethodRouter}, BoxError, }; use async_trait::async_trait; use bytes::Bytes; use http::{Request, Response}; use std::{fmt, future::Future, marker::PhantomData}; use tower::ServiceExt; use tower_layer::Layer; use tower_service::Service; pub mod future; mod into_service; pub use self::into_service::IntoService; pub(crate) mod sealed { #![allow(unreachable_pub, missing_docs, missing_debug_implementations)] pub trait HiddentTrait {} pub struct Hidden; impl HiddentTrait for Hidden {} } /// Trait for async functions that can be used to handle requests. /// /// You shouldn't need to depend on this trait directly. It is automatically /// implemented to closures of the right types. /// /// See the [module docs](crate::handler) for more details. #[async_trait] pub trait Handler: Clone + Send + Sized + 'static { // This seals the trait. We cannot use the regular "sealed super trait" // approach due to coherence. #[doc(hidden)] type Sealed: sealed::HiddentTrait; /// Call the handler with the given request. async fn call(self, req: Request) -> Response; /// Apply a [`tower::Layer`] to the handler. /// /// All requests to the handler will be processed by the layer's /// corresponding middleware. /// /// This can be used to add additional processing to a request for a single /// handler. /// /// Note this differs from [`routing::Router::layer`](crate::routing::Router::layer) /// which adds a middleware to a group of routes. /// /// # Example /// /// Adding the [`tower::limit::ConcurrencyLimit`] middleware to a handler /// can be done like so: /// /// ```rust /// use axum::{ /// routing::get, /// handler::Handler, /// Router, /// }; /// use tower::limit::{ConcurrencyLimitLayer, ConcurrencyLimit}; /// /// async fn handler() { /* ... */ } /// /// let layered_handler = handler.layer(ConcurrencyLimitLayer::new(64)); /// let app = Router::new().route("/", get(layered_handler)); /// # async { /// # axum::Server::bind(&"".parse().unwrap()).serve(app.into_make_service()).await.unwrap(); /// # }; /// ``` fn layer(self, layer: L) -> Layered where L: Layer>, { Layered::new(layer.layer(crate::routing::any(self))) } /// Convert the handler into a [`Service`]. /// /// This allows you to serve a single handler if you don't need any routing: /// /// ```rust /// use axum::{ /// Server, handler::Handler, http::{Uri, Method}, response::IntoResponse, /// }; /// use tower::make::Shared; /// use std::net::SocketAddr; /// /// async fn handler(method: Method, uri: Uri, body: String) -> impl IntoResponse { /// format!("received `{} {}` with body `{:?}`", method, uri, body) /// } /// /// let service = handler.into_service(); /// /// # async { /// Server::bind(&SocketAddr::from(([127, 0, 0, 1], 3000))) /// .serve(Shared::new(service)) /// .await?; /// # Ok::<_, hyper::Error>(()) /// # }; /// ``` fn into_service(self) -> IntoService { IntoService::new(self) } } #[async_trait] impl Handler for F where F: FnOnce() -> Fut + Clone + Send + Sync + 'static, Fut: Future + Send, Res: IntoResponse, B: Send + 'static, { type Sealed = sealed::Hidden; async fn call(self, _req: Request) -> Response { self().await.into_response().map(box_body) } } macro_rules! impl_handler { ( $($ty:ident),* $(,)? ) => { #[async_trait] #[allow(non_snake_case)] impl Handler for F where F: FnOnce($($ty,)*) -> Fut + Clone + Send + Sync + 'static, Fut: Future + Send, B: Send + 'static, Res: IntoResponse, $( $ty: FromRequest + Send,)* { type Sealed = sealed::Hidden; async fn call(self, req: Request) -> Response { let mut req = RequestParts::new(req); $( let $ty = match $ty::from_request(&mut req).await { Ok(value) => value, Err(rejection) => return rejection.into_response().map(box_body), }; )* let res = self($($ty,)*).await; res.into_response().map(box_body) } } }; } impl_handler!(T1); impl_handler!(T1, T2); impl_handler!(T1, T2, T3); impl_handler!(T1, T2, T3, T4); impl_handler!(T1, T2, T3, T4, T5); impl_handler!(T1, T2, T3, T4, T5, T6); impl_handler!(T1, T2, T3, T4, T5, T6, T7); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15); impl_handler!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16); /// A [`Service`] created from a [`Handler`] by applying a Tower middleware. /// /// Created with [`Handler::layer`]. See that method for more details. pub struct Layered { svc: S, _input: PhantomData T>, } impl fmt::Debug for Layered where S: fmt::Debug, { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("Layered").field("svc", &self.svc).finish() } } impl Clone for Layered where S: Clone, { fn clone(&self) -> Self { Self::new(self.svc.clone()) } } #[async_trait] impl Handler for Layered where S: Service, Response = Response> + Clone + Send + 'static, S::Error: IntoResponse, S::Future: Send, T: 'static, ReqBody: Send + 'static, ResBody: http_body::Body + Send + Sync + 'static, ResBody::Error: Into + Send + Sync + 'static, { type Sealed = sealed::Hidden; async fn call(self, req: Request) -> Response { match self .svc .oneshot(req) .await .map_err(IntoResponse::into_response) { Ok(res) => res.map(box_body), Err(res) => res.map(box_body), } } } impl Layered { pub(crate) fn new(svc: S) -> Self { Self { svc, _input: PhantomData, } } } #[test] fn traits() { use crate::tests::*; assert_send::>(); assert_sync::>(); }