1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-25 00:12:59 +01:00
actix-extras/guide/src/qs_4.md

150 lines
3.8 KiB
Markdown
Raw Normal View History

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
[`FromRequest` trait](../actix_web/trait.FromRequest.html#foreign-impls).
Then `from_request()` get called on returned object. And finally
result of the `from_request()` call get converted to `Reply` object.
By default actix provides several `FromRequest` implementations for some standard types,
2017-12-02 08:42:21 +01:00
like `&'static str`, `String`, etc.
For complete list of implementations check
[FromRequest documentation](../actix_web/trait.FromRequest.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-09 00:25:37 +01:00
To return custom type directly from handler function `FromResponse` trait should be
implemented for this type. 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
}
/// we have to convert Error into HttpResponse as well
impl FromRequest for MyObj {
type Item = HttpResponse;
type Error = Error;
fn from_request(self, req: HttpRequest) -> Result<HttpResponse> {
let body = serde_json::to_string(&self)?;
2017-12-02 08:42:21 +01:00
// Create response and set content type
Ok(HttpResponse::Ok()
2017-12-02 08:42:21 +01:00
.content_type("application/json")
.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(
|| Application::new()
2017-12-09 00:25:37 +01:00
.resource("/", |r| r.method(Method::GET).f(index)))
2017-12-02 08:42:21 +01:00
.serve::<_, ()>("127.0.0.1:8088").unwrap();
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() {
Application::new()
.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() {
Application::new()
.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)