mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-23 16:21:06 +01:00
Rename factory to handler (#1852)
This commit is contained in:
parent
1032f04ded
commit
cbda928a33
@ -3,13 +3,13 @@
|
|||||||
## Unreleased - 2020-xx-xx
|
## Unreleased - 2020-xx-xx
|
||||||
### Changed
|
### Changed
|
||||||
* Bumped `rand` to `0.8`
|
* Bumped `rand` to `0.8`
|
||||||
|
* Rename `Handler` to `HandlerService` and rename `Factory` to `Handler`. [#1852]
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
* added the actual parsing error to `test::read_body_json` [#1812]
|
* added the actual parsing error to `test::read_body_json` [#1812]
|
||||||
|
|
||||||
[#1812]: https://github.com/actix/actix-web/pull/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
|
## 3.3.2 - 2020-12-01
|
||||||
### Fixed
|
### Fixed
|
||||||
|
@ -14,20 +14,25 @@ use crate::request::HttpRequest;
|
|||||||
use crate::responder::Responder;
|
use crate::responder::Responder;
|
||||||
use crate::service::{ServiceRequest, ServiceResponse};
|
use crate::service::{ServiceRequest, ServiceResponse};
|
||||||
|
|
||||||
/// Async handler converter factory
|
/// A request handler is an async function that accepts zero or more parameters that can be
|
||||||
pub trait Factory<T, R, O>: Clone + 'static
|
/// 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<T, R>: Clone + 'static
|
||||||
where
|
where
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
fn call(&self, param: T) -> R;
|
fn call(&self, param: T) -> R;
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<F, R, O> Factory<(), R, O> for F
|
impl<F, R> Handler<(), R> for F
|
||||||
where
|
where
|
||||||
F: Fn() -> R + Clone + 'static,
|
F: Fn() -> R + Clone + 'static,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
fn call(&self, _: ()) -> R {
|
fn call(&self, _: ()) -> R {
|
||||||
(self)()
|
(self)()
|
||||||
@ -36,53 +41,53 @@ where
|
|||||||
|
|
||||||
#[doc(hidden)]
|
#[doc(hidden)]
|
||||||
/// Extract arguments from request, run factory function and make response.
|
/// Extract arguments from request, run factory function and make response.
|
||||||
pub struct Handler<F, T, R, O>
|
pub struct HandlerService<F, T, R>
|
||||||
where
|
where
|
||||||
F: Factory<T, R, O>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest,
|
T: FromRequest,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
hnd: F,
|
hnd: F,
|
||||||
_t: PhantomData<(T, R, O)>,
|
_t: PhantomData<(T, R)>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<F, T, R, O> Handler<F, T, R, O>
|
impl<F, T, R> HandlerService<F, T, R>
|
||||||
where
|
where
|
||||||
F: Factory<T, R, O>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest,
|
T: FromRequest,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
pub fn new(hnd: F) -> Self {
|
pub fn new(hnd: F) -> Self {
|
||||||
Handler {
|
Self {
|
||||||
hnd,
|
hnd,
|
||||||
_t: PhantomData,
|
_t: PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<F, T, R, O> Clone for Handler<F, T, R, O>
|
impl<F, T, R> Clone for HandlerService<F, T, R>
|
||||||
where
|
where
|
||||||
F: Factory<T, R, O>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest,
|
T: FromRequest,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
fn clone(&self) -> Self {
|
fn clone(&self) -> Self {
|
||||||
Handler {
|
Self {
|
||||||
hnd: self.hnd.clone(),
|
hnd: self.hnd.clone(),
|
||||||
_t: PhantomData,
|
_t: PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<F, T, R, O> ServiceFactory for Handler<F, T, R, O>
|
impl<F, T, R> ServiceFactory for HandlerService<F, T, R>
|
||||||
where
|
where
|
||||||
F: Factory<T, R, O>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest,
|
T: FromRequest,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
type Request = ServiceRequest;
|
type Request = ServiceRequest;
|
||||||
type Response = ServiceResponse;
|
type Response = ServiceResponse;
|
||||||
@ -97,18 +102,18 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handler is both it's ServiceFactory and Service Type.
|
// Handler is both it's ServiceHandler and Service Type.
|
||||||
impl<F, T, R, O> Service for Handler<F, T, R, O>
|
impl<F, T, R> Service for HandlerService<F, T, R>
|
||||||
where
|
where
|
||||||
F: Factory<T, R, O>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest,
|
T: FromRequest,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
type Request = ServiceRequest;
|
type Request = ServiceRequest;
|
||||||
type Response = ServiceResponse;
|
type Response = ServiceResponse;
|
||||||
type Error = Error;
|
type Error = Error;
|
||||||
type Future = HandlerServiceFuture<F, T, R, O>;
|
type Future = HandlerServiceFuture<F, T, R>;
|
||||||
|
|
||||||
fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
|
fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
|
||||||
Poll::Ready(Ok(()))
|
Poll::Ready(Ok(()))
|
||||||
@ -123,24 +128,24 @@ where
|
|||||||
|
|
||||||
#[doc(hidden)]
|
#[doc(hidden)]
|
||||||
#[pin_project(project = HandlerProj)]
|
#[pin_project(project = HandlerProj)]
|
||||||
pub enum HandlerServiceFuture<F, T, R, O>
|
pub enum HandlerServiceFuture<F, T, R>
|
||||||
where
|
where
|
||||||
F: Factory<T, R, O>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest,
|
T: FromRequest,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
Extract(#[pin] T::Future, Option<HttpRequest>, F),
|
Extract(#[pin] T::Future, Option<HttpRequest>, F),
|
||||||
Handle(#[pin] R, Option<HttpRequest>),
|
Handle(#[pin] R, Option<HttpRequest>),
|
||||||
Respond(#[pin] O::Future, Option<HttpRequest>),
|
Respond(#[pin] <R::Output as Responder>::Future, Option<HttpRequest>),
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<F, T, R, O> Future for HandlerServiceFuture<F, T, R, O>
|
impl<F, T, R> Future for HandlerServiceFuture<F, T, R>
|
||||||
where
|
where
|
||||||
F: Factory<T, R, O>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest,
|
T: FromRequest,
|
||||||
R: Future<Output = O>,
|
R: Future,
|
||||||
O: Responder,
|
R::Output: Responder,
|
||||||
{
|
{
|
||||||
// Error type in this future is a placeholder type.
|
// Error type in this future is a placeholder type.
|
||||||
// all instances of error must be converted to ServiceResponse and return in Ok.
|
// all instances of error must be converted to ServiceResponse and return in Ok.
|
||||||
@ -181,10 +186,10 @@ where
|
|||||||
|
|
||||||
/// FromRequest trait impl for tuples
|
/// FromRequest trait impl for tuples
|
||||||
macro_rules! factory_tuple ({ $(($n:tt, $T:ident)),+} => {
|
macro_rules! factory_tuple ({ $(($n:tt, $T:ident)),+} => {
|
||||||
impl<Func, $($T,)+ Res, O> Factory<($($T,)+), Res, O> for Func
|
impl<Func, $($T,)+ Res> Handler<($($T,)+), Res> for Func
|
||||||
where Func: Fn($($T,)+) -> Res + Clone + 'static,
|
where Func: Fn($($T,)+) -> Res + Clone + 'static,
|
||||||
Res: Future<Output = O>,
|
Res: Future,
|
||||||
O: Responder,
|
Res::Output: Responder,
|
||||||
{
|
{
|
||||||
fn call(&self, param: ($($T,)+)) -> Res {
|
fn call(&self, param: ($($T,)+)) -> Res {
|
||||||
(self)($(param.$n,)+)
|
(self)($(param.$n,)+)
|
||||||
|
@ -121,7 +121,7 @@ pub mod dev {
|
|||||||
|
|
||||||
pub use crate::config::{AppConfig, AppService};
|
pub use crate::config::{AppConfig, AppService};
|
||||||
#[doc(hidden)]
|
#[doc(hidden)]
|
||||||
pub use crate::handler::Factory;
|
pub use crate::handler::Handler;
|
||||||
pub use crate::info::ConnectionInfo;
|
pub use crate::info::ConnectionInfo;
|
||||||
pub use crate::rmap::ResourceMap;
|
pub use crate::rmap::ResourceMap;
|
||||||
pub use crate::service::{
|
pub use crate::service::{
|
||||||
|
@ -17,7 +17,7 @@ use crate::data::Data;
|
|||||||
use crate::dev::{insert_slash, AppService, HttpServiceFactory, ResourceDef};
|
use crate::dev::{insert_slash, AppService, HttpServiceFactory, ResourceDef};
|
||||||
use crate::extract::FromRequest;
|
use crate::extract::FromRequest;
|
||||||
use crate::guard::Guard;
|
use crate::guard::Guard;
|
||||||
use crate::handler::Factory;
|
use crate::handler::Handler;
|
||||||
use crate::responder::Responder;
|
use crate::responder::Responder;
|
||||||
use crate::route::{CreateRouteService, Route, RouteService};
|
use crate::route::{CreateRouteService, Route, RouteService};
|
||||||
use crate::service::{ServiceRequest, ServiceResponse};
|
use crate::service::{ServiceRequest, ServiceResponse};
|
||||||
@ -227,12 +227,12 @@ where
|
|||||||
/// # fn index(req: HttpRequest) -> HttpResponse { unimplemented!() }
|
/// # fn index(req: HttpRequest) -> HttpResponse { unimplemented!() }
|
||||||
/// App::new().service(web::resource("/").route(web::route().to(index)));
|
/// App::new().service(web::resource("/").route(web::route().to(index)));
|
||||||
/// ```
|
/// ```
|
||||||
pub fn to<F, I, R, U>(mut self, handler: F) -> Self
|
pub fn to<F, I, R>(mut self, handler: F) -> Self
|
||||||
where
|
where
|
||||||
F: Factory<I, R, U>,
|
F: Handler<I, R>,
|
||||||
I: FromRequest + 'static,
|
I: FromRequest + 'static,
|
||||||
R: Future<Output = U> + 'static,
|
R: Future + 'static,
|
||||||
U: Responder + 'static,
|
R::Output: Responder + 'static,
|
||||||
{
|
{
|
||||||
self.routes.push(Route::new().to(handler));
|
self.routes.push(Route::new().to(handler));
|
||||||
self
|
self
|
||||||
|
14
src/route.rs
14
src/route.rs
@ -11,7 +11,7 @@ use futures_util::future::{ready, FutureExt, LocalBoxFuture};
|
|||||||
|
|
||||||
use crate::extract::FromRequest;
|
use crate::extract::FromRequest;
|
||||||
use crate::guard::{self, Guard};
|
use crate::guard::{self, Guard};
|
||||||
use crate::handler::{Factory, Handler};
|
use crate::handler::{Handler, HandlerService};
|
||||||
use crate::responder::Responder;
|
use crate::responder::Responder;
|
||||||
use crate::service::{ServiceRequest, ServiceResponse};
|
use crate::service::{ServiceRequest, ServiceResponse};
|
||||||
use crate::HttpResponse;
|
use crate::HttpResponse;
|
||||||
@ -51,7 +51,7 @@ impl Route {
|
|||||||
#[allow(clippy::new_without_default)]
|
#[allow(clippy::new_without_default)]
|
||||||
pub fn new() -> Route {
|
pub fn new() -> Route {
|
||||||
Route {
|
Route {
|
||||||
service: Box::new(RouteNewService::new(Handler::new(|| {
|
service: Box::new(RouteNewService::new(HandlerService::new(|| {
|
||||||
ready(HttpResponse::NotFound())
|
ready(HttpResponse::NotFound())
|
||||||
}))),
|
}))),
|
||||||
guards: Rc::new(Vec::new()),
|
guards: Rc::new(Vec::new()),
|
||||||
@ -219,14 +219,14 @@ impl Route {
|
|||||||
/// );
|
/// );
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
pub fn to<F, T, R, U>(mut self, handler: F) -> Self
|
pub fn to<F, T, R>(mut self, handler: F) -> Self
|
||||||
where
|
where
|
||||||
F: Factory<T, R, U>,
|
F: Handler<T, R>,
|
||||||
T: FromRequest + 'static,
|
T: FromRequest + 'static,
|
||||||
R: Future<Output = U> + 'static,
|
R: Future + 'static,
|
||||||
U: Responder + 'static,
|
R::Output: Responder + 'static,
|
||||||
{
|
{
|
||||||
self.service = Box::new(RouteNewService::new(Handler::new(handler)));
|
self.service = Box::new(RouteNewService::new(HandlerService::new(handler)));
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
10
src/web.rs
10
src/web.rs
@ -9,7 +9,7 @@ pub use futures_channel::oneshot::Canceled;
|
|||||||
|
|
||||||
use crate::error::BlockingError;
|
use crate::error::BlockingError;
|
||||||
use crate::extract::FromRequest;
|
use crate::extract::FromRequest;
|
||||||
use crate::handler::Factory;
|
use crate::handler::Handler;
|
||||||
use crate::resource::Resource;
|
use crate::resource::Resource;
|
||||||
use crate::responder::Responder;
|
use crate::responder::Responder;
|
||||||
use crate::route::Route;
|
use crate::route::Route;
|
||||||
@ -244,12 +244,12 @@ pub fn method(method: Method) -> Route {
|
|||||||
/// web::to(index))
|
/// web::to(index))
|
||||||
/// );
|
/// );
|
||||||
/// ```
|
/// ```
|
||||||
pub fn to<F, I, R, U>(handler: F) -> Route
|
pub fn to<F, I, R>(handler: F) -> Route
|
||||||
where
|
where
|
||||||
F: Factory<I, R, U>,
|
F: Handler<I, R>,
|
||||||
I: FromRequest + 'static,
|
I: FromRequest + 'static,
|
||||||
R: Future<Output = U> + 'static,
|
R: Future + 'static,
|
||||||
U: Responder + 'static,
|
R::Output: Responder + 'static,
|
||||||
{
|
{
|
||||||
Route::new().to(handler)
|
Route::new().to(handler)
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user