2017-12-02 08:42:21 +01:00
|
|
|
# Handler
|
|
|
|
|
|
|
|
A request handler can by any object that implements
|
2017-12-09 00:25:37 +01:00
|
|
|
[`Handler` trait](../actix_web/dev/trait.Handler.html#implementors).
|
|
|
|
Request handling happen in two stages. First handler object get called.
|
|
|
|
Handle can return any object that implements
|
2017-12-14 18:43:42 +01:00
|
|
|
[*Responder trait*](../actix_web/trait.Responder.html#foreign-impls).
|
|
|
|
Then `respond_to()` get called on returned object. And finally
|
|
|
|
result of the `respond_to()` call get converted to `Reply` object.
|
2017-12-09 00:25:37 +01:00
|
|
|
|
2017-12-14 18:43:42 +01:00
|
|
|
By default actix provides `Responder` implementations for some standard types,
|
2017-12-02 08:42:21 +01:00
|
|
|
like `&'static str`, `String`, etc.
|
|
|
|
For complete list of implementations check
|
2017-12-14 18:43:42 +01:00
|
|
|
[Responder documentation](../actix_web/trait.Responder.html#foreign-impls).
|
2017-12-02 08:42:21 +01:00
|
|
|
|
2017-12-09 00:25:37 +01:00
|
|
|
Examples of valid handlers:
|
2017-12-02 08:42:21 +01:00
|
|
|
|
|
|
|
```rust,ignore
|
|
|
|
fn index(req: HttpRequest) -> &'static str {
|
|
|
|
"Hello world!"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
```rust,ignore
|
|
|
|
fn index(req: HttpRequest) -> String {
|
|
|
|
"Hello world!".to_owned()
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
```rust,ignore
|
|
|
|
fn index(req: HttpRequest) -> Bytes {
|
|
|
|
Bytes::from_static("Hello world!")
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
```rust,ignore
|
|
|
|
fn index(req: HttpRequest) -> Box<Future<Item=HttpResponse, Error=Error>> {
|
|
|
|
...
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2017-12-09 00:25:37 +01:00
|
|
|
## Response with custom type
|
2017-12-02 08:42:21 +01:00
|
|
|
|
2017-12-15 05:12:28 +01:00
|
|
|
To return custom type directly from handler function type needs to implement `Responder` trait.
|
|
|
|
Let's create response for custom type that serializes to `application/json` response:
|
2017-12-02 08:42:21 +01:00
|
|
|
|
|
|
|
```rust
|
2017-12-06 20:00:39 +01:00
|
|
|
# extern crate actix;
|
|
|
|
# extern crate actix_web;
|
2017-12-02 08:42:21 +01:00
|
|
|
extern crate serde;
|
|
|
|
extern crate serde_json;
|
|
|
|
#[macro_use] extern crate serde_derive;
|
|
|
|
use actix_web::*;
|
|
|
|
|
|
|
|
#[derive(Serialize)]
|
|
|
|
struct MyObj {
|
2017-12-09 00:25:37 +01:00
|
|
|
name: &'static str,
|
2017-12-02 08:42:21 +01:00
|
|
|
}
|
|
|
|
|
2017-12-03 23:22:04 +01:00
|
|
|
/// we have to convert Error into HttpResponse as well
|
2017-12-14 18:43:42 +01:00
|
|
|
impl Responder for MyObj {
|
2017-12-03 23:22:04 +01:00
|
|
|
type Item = HttpResponse;
|
|
|
|
type Error = Error;
|
|
|
|
|
2017-12-14 18:43:42 +01:00
|
|
|
fn respond_to(self, req: HttpRequest) -> Result<HttpResponse> {
|
2017-12-03 23:22:04 +01:00
|
|
|
let body = serde_json::to_string(&self)?;
|
2017-12-02 08:42:21 +01:00
|
|
|
|
|
|
|
// Create response and set content type
|
2017-12-03 23:22:04 +01:00
|
|
|
Ok(HttpResponse::Ok()
|
2017-12-02 08:42:21 +01:00
|
|
|
.content_type("application/json")
|
2017-12-03 23:22:04 +01:00
|
|
|
.body(body)?)
|
2017-12-02 08:42:21 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-12-09 00:25:37 +01:00
|
|
|
fn index(req: HttpRequest) -> MyObj {
|
|
|
|
MyObj{name: "user"}
|
|
|
|
}
|
|
|
|
|
2017-12-02 08:42:21 +01:00
|
|
|
fn main() {
|
|
|
|
let sys = actix::System::new("example");
|
|
|
|
|
|
|
|
HttpServer::new(
|
2017-12-12 16:40:36 +01:00
|
|
|
|| Application::new()
|
2017-12-09 00:25:37 +01:00
|
|
|
.resource("/", |r| r.method(Method::GET).f(index)))
|
2017-12-17 21:35:04 +01:00
|
|
|
.bind("127.0.0.1:8088").unwrap()
|
|
|
|
.start();
|
2017-12-02 08:42:21 +01:00
|
|
|
|
|
|
|
println!("Started http server: 127.0.0.1:8088");
|
2017-12-09 00:25:37 +01:00
|
|
|
# actix::Arbiter::system().send(actix::msgs::SystemExit(0));
|
2017-12-02 08:42:21 +01:00
|
|
|
let _ = sys.run();
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Async handlers
|
|
|
|
|
|
|
|
There are two different types of async handlers.
|
|
|
|
|
|
|
|
Response object could be generated asynchronously. In this case handle must
|
|
|
|
return `Future` object that resolves to `HttpResponse`, i.e:
|
|
|
|
|
2017-12-05 01:09:22 +01:00
|
|
|
```rust
|
|
|
|
# extern crate actix_web;
|
|
|
|
# extern crate futures;
|
|
|
|
# extern crate bytes;
|
|
|
|
# use actix_web::*;
|
|
|
|
# use bytes::Bytes;
|
|
|
|
# use futures::stream::once;
|
|
|
|
# use futures::future::{FutureResult, result};
|
|
|
|
fn index(req: HttpRequest) -> FutureResult<HttpResponse, Error> {
|
|
|
|
|
|
|
|
result(HttpResponse::Ok()
|
|
|
|
.content_type("text/html")
|
|
|
|
.body(format!("Hello!"))
|
|
|
|
.map_err(|e| e.into()))
|
2017-12-02 08:42:21 +01:00
|
|
|
}
|
|
|
|
|
2017-12-05 01:09:22 +01:00
|
|
|
fn main() {
|
2017-12-11 23:16:29 +01:00
|
|
|
Application::new()
|
2017-12-06 17:03:08 +01:00
|
|
|
.resource("/async", |r| r.route().a(index))
|
2017-12-05 01:09:22 +01:00
|
|
|
.finish();
|
|
|
|
}
|
|
|
|
```
|
2017-12-02 08:42:21 +01:00
|
|
|
|
|
|
|
Or response body can be generated asynchronously. In this case body
|
|
|
|
must implement stream trait `Stream<Item=Bytes, Error=Error>`, i.e:
|
|
|
|
|
2017-12-05 01:09:22 +01:00
|
|
|
```rust
|
|
|
|
# extern crate actix_web;
|
|
|
|
# extern crate futures;
|
|
|
|
# extern crate bytes;
|
|
|
|
# use actix_web::*;
|
|
|
|
# use bytes::Bytes;
|
|
|
|
# use futures::stream::once;
|
2017-12-02 08:42:21 +01:00
|
|
|
fn index(req: HttpRequest) -> HttpResponse {
|
2017-12-05 01:09:22 +01:00
|
|
|
let body = once(Ok(Bytes::from_static(b"test")));
|
2017-12-02 08:42:21 +01:00
|
|
|
|
2017-12-05 01:09:22 +01:00
|
|
|
HttpResponse::Ok()
|
2017-12-02 08:42:21 +01:00
|
|
|
.content_type("application/json")
|
2017-12-05 01:09:22 +01:00
|
|
|
.body(Body::Streaming(Box::new(body))).unwrap()
|
2017-12-02 08:42:21 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
fn main() {
|
2017-12-11 23:16:29 +01:00
|
|
|
Application::new()
|
2017-12-06 17:03:08 +01:00
|
|
|
.resource("/async", |r| r.f(index))
|
2017-12-02 08:42:21 +01:00
|
|
|
.finish();
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
Both methods could be combined. (i.e Async response with streaming body)
|