From cbda928a33ce69e5d83059ff459464ba2a60b19f Mon Sep 17 00:00:00 2001 From: Ibraheem Ahmed Date: Sat, 26 Dec 2020 16:46:19 -0500 Subject: [PATCH] Rename factory to handler (#1852) --- CHANGES.md | 4 +-- src/handler.rs | 93 ++++++++++++++++++++++++++----------------------- src/lib.rs | 2 +- src/resource.rs | 10 +++--- src/route.rs | 14 ++++---- src/web.rs | 10 +++--- 6 files changed, 69 insertions(+), 64 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index ee9b9308..da04c5aa 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -3,13 +3,13 @@ ## Unreleased - 2020-xx-xx ### Changed * Bumped `rand` to `0.8` +* Rename `Handler` to `HandlerService` and rename `Factory` to `Handler`. [#1852] ### Fixed * added the actual parsing error to `test::read_body_json` [#1812] [#1812]: https://github.com/actix/actix-web/pull/1812 - - +[#1852]: https://github.com/actix/actix-web/pull/1852 ## 3.3.2 - 2020-12-01 ### Fixed diff --git a/src/handler.rs b/src/handler.rs index 3d0a2382..b928939a 100644 --- a/src/handler.rs +++ b/src/handler.rs @@ -14,20 +14,25 @@ use crate::request::HttpRequest; use crate::responder::Responder; use crate::service::{ServiceRequest, ServiceResponse}; -/// Async handler converter factory -pub trait Factory: Clone + 'static +/// A request handler is an async function that accepts zero or more parameters that can be +/// extracted from a request (ie, [`impl FromRequest`](crate::FromRequest)) and returns a type that can be converted into +/// an [`HttpResponse`](crate::HttpResponse) (ie, [`impl Responder`](crate::Responder)). +/// +/// If you got the error `the trait Handler<_, _, _> is not implemented`, then your function is not +/// a valid handler. See [Request Handlers](https://actix.rs/docs/handlers/) for more information. +pub trait Handler: Clone + 'static where - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { fn call(&self, param: T) -> R; } -impl Factory<(), R, O> for F +impl Handler<(), R> for F where F: Fn() -> R + Clone + 'static, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { fn call(&self, _: ()) -> R { (self)() @@ -36,53 +41,53 @@ where #[doc(hidden)] /// Extract arguments from request, run factory function and make response. -pub struct Handler +pub struct HandlerService where - F: Factory, + F: Handler, T: FromRequest, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { hnd: F, - _t: PhantomData<(T, R, O)>, + _t: PhantomData<(T, R)>, } -impl Handler +impl HandlerService where - F: Factory, + F: Handler, T: FromRequest, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { pub fn new(hnd: F) -> Self { - Handler { + Self { hnd, _t: PhantomData, } } } -impl Clone for Handler +impl Clone for HandlerService where - F: Factory, + F: Handler, T: FromRequest, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { fn clone(&self) -> Self { - Handler { + Self { hnd: self.hnd.clone(), _t: PhantomData, } } } -impl ServiceFactory for Handler +impl ServiceFactory for HandlerService where - F: Factory, + F: Handler, T: FromRequest, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { type Request = ServiceRequest; type Response = ServiceResponse; @@ -97,18 +102,18 @@ where } } -// Handler is both it's ServiceFactory and Service Type. -impl Service for Handler +// Handler is both it's ServiceHandler and Service Type. +impl Service for HandlerService where - F: Factory, + F: Handler, T: FromRequest, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { type Request = ServiceRequest; type Response = ServiceResponse; type Error = Error; - type Future = HandlerServiceFuture; + type Future = HandlerServiceFuture; fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll> { Poll::Ready(Ok(())) @@ -123,24 +128,24 @@ where #[doc(hidden)] #[pin_project(project = HandlerProj)] -pub enum HandlerServiceFuture +pub enum HandlerServiceFuture where - F: Factory, + F: Handler, T: FromRequest, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { Extract(#[pin] T::Future, Option, F), Handle(#[pin] R, Option), - Respond(#[pin] O::Future, Option), + Respond(#[pin] ::Future, Option), } -impl Future for HandlerServiceFuture +impl Future for HandlerServiceFuture where - F: Factory, + F: Handler, T: FromRequest, - R: Future, - O: Responder, + R: Future, + R::Output: Responder, { // Error type in this future is a placeholder type. // all instances of error must be converted to ServiceResponse and return in Ok. @@ -181,10 +186,10 @@ where /// FromRequest trait impl for tuples macro_rules! factory_tuple ({ $(($n:tt, $T:ident)),+} => { - impl Factory<($($T,)+), Res, O> for Func + impl Handler<($($T,)+), Res> for Func where Func: Fn($($T,)+) -> Res + Clone + 'static, - Res: Future, - O: Responder, + Res: Future, + Res::Output: Responder, { fn call(&self, param: ($($T,)+)) -> Res { (self)($(param.$n,)+) diff --git a/src/lib.rs b/src/lib.rs index b8346d96..8246c828 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -121,7 +121,7 @@ pub mod dev { pub use crate::config::{AppConfig, AppService}; #[doc(hidden)] - pub use crate::handler::Factory; + pub use crate::handler::Handler; pub use crate::info::ConnectionInfo; pub use crate::rmap::ResourceMap; pub use crate::service::{ diff --git a/src/resource.rs b/src/resource.rs index dd9b2301..f6046d65 100644 --- a/src/resource.rs +++ b/src/resource.rs @@ -17,7 +17,7 @@ use crate::data::Data; use crate::dev::{insert_slash, AppService, HttpServiceFactory, ResourceDef}; use crate::extract::FromRequest; use crate::guard::Guard; -use crate::handler::Factory; +use crate::handler::Handler; use crate::responder::Responder; use crate::route::{CreateRouteService, Route, RouteService}; use crate::service::{ServiceRequest, ServiceResponse}; @@ -227,12 +227,12 @@ where /// # fn index(req: HttpRequest) -> HttpResponse { unimplemented!() } /// App::new().service(web::resource("/").route(web::route().to(index))); /// ``` - pub fn to(mut self, handler: F) -> Self + pub fn to(mut self, handler: F) -> Self where - F: Factory, + F: Handler, I: FromRequest + 'static, - R: Future + 'static, - U: Responder + 'static, + R: Future + 'static, + R::Output: Responder + 'static, { self.routes.push(Route::new().to(handler)); self diff --git a/src/route.rs b/src/route.rs index 439ae6c4..00d93fce 100644 --- a/src/route.rs +++ b/src/route.rs @@ -11,7 +11,7 @@ use futures_util::future::{ready, FutureExt, LocalBoxFuture}; use crate::extract::FromRequest; use crate::guard::{self, Guard}; -use crate::handler::{Factory, Handler}; +use crate::handler::{Handler, HandlerService}; use crate::responder::Responder; use crate::service::{ServiceRequest, ServiceResponse}; use crate::HttpResponse; @@ -51,7 +51,7 @@ impl Route { #[allow(clippy::new_without_default)] pub fn new() -> Route { Route { - service: Box::new(RouteNewService::new(Handler::new(|| { + service: Box::new(RouteNewService::new(HandlerService::new(|| { ready(HttpResponse::NotFound()) }))), guards: Rc::new(Vec::new()), @@ -219,14 +219,14 @@ impl Route { /// ); /// } /// ``` - pub fn to(mut self, handler: F) -> Self + pub fn to(mut self, handler: F) -> Self where - F: Factory, + F: Handler, T: FromRequest + 'static, - R: Future + 'static, - U: Responder + 'static, + R: Future + 'static, + R::Output: Responder + 'static, { - self.service = Box::new(RouteNewService::new(Handler::new(handler))); + self.service = Box::new(RouteNewService::new(HandlerService::new(handler))); self } } diff --git a/src/web.rs b/src/web.rs index bf215891..85e5f2e7 100644 --- a/src/web.rs +++ b/src/web.rs @@ -9,7 +9,7 @@ pub use futures_channel::oneshot::Canceled; use crate::error::BlockingError; use crate::extract::FromRequest; -use crate::handler::Factory; +use crate::handler::Handler; use crate::resource::Resource; use crate::responder::Responder; use crate::route::Route; @@ -244,12 +244,12 @@ pub fn method(method: Method) -> Route { /// web::to(index)) /// ); /// ``` -pub fn to(handler: F) -> Route +pub fn to(handler: F) -> Route where - F: Factory, + F: Handler, I: FromRequest + 'static, - R: Future + 'static, - U: Responder + 'static, + R: Future + 'static, + R::Output: Responder + 'static, { Route::new().to(handler) }