From d912bf8771adca12dfd70fc1def29982a29b2e1a Mon Sep 17 00:00:00 2001 From: Pascal Hertleif Date: Sat, 2 Jun 2018 00:57:24 +0200 Subject: [PATCH] Add more docs to ResourceHandler API --- src/resource.rs | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/src/resource.rs b/src/resource.rs index 2e2b8c6b9..af3a9e673 100644 --- a/src/resource.rs +++ b/src/resource.rs @@ -128,6 +128,14 @@ impl ResourceHandler { /// Register a new route and add method check to route. /// + /// ```rust + /// # extern crate actix_web; + /// use actix_web::*; + /// fn index(req: HttpRequest) -> HttpResponse { unimplemented!() } + /// + /// App::new().resource("/", |r| r.method(http::Method::GET).f(index)); + /// ``` + /// /// This is shortcut for: /// /// ```rust @@ -143,6 +151,14 @@ impl ResourceHandler { /// Register a new route and add handler object. /// + /// ```rust + /// # extern crate actix_web; + /// use actix_web::*; + /// fn handler(req: HttpRequest) -> HttpResponse { unimplemented!() } + /// + /// App::new().resource("/", |r| r.h(handler)); + /// ``` + /// /// This is shortcut for: /// /// ```rust @@ -158,6 +174,14 @@ impl ResourceHandler { /// Register a new route and add handler function. /// + /// ```rust + /// # extern crate actix_web; + /// use actix_web::*; + /// fn index(req: HttpRequest) -> HttpResponse { unimplemented!() } + /// + /// App::new().resource("/", |r| r.f(index)); + /// ``` + /// /// This is shortcut for: /// /// ```rust @@ -177,6 +201,14 @@ impl ResourceHandler { /// Register a new route and add handler. /// + /// ```rust + /// # extern crate actix_web; + /// use actix_web::*; + /// fn index(req: HttpRequest) -> HttpResponse { unimplemented!() } + /// + /// App::new().resource("/", |r| r.with(index)); + /// ``` + /// /// This is shortcut for: /// /// ```rust @@ -197,6 +229,19 @@ impl ResourceHandler { /// Register a new route and add async handler. /// + /// ```rust + /// # extern crate actix_web; + /// # extern crate futures; + /// use actix_web::*; + /// use futures::future::Future; + /// + /// fn index(req: HttpRequest) -> Box> { + /// unimplemented!() + /// } + /// + /// App::new().resource("/", |r| r.with_async(index)); + /// ``` + /// /// This is shortcut for: /// /// ```rust