2018-05-22 23:15:08 +02:00
---
title: Handlers
menu: docs_basics
weight: 160
---
# Request Handlers
2022-02-26 05:41:49 +01:00
A request handler is an async function that accepts zero or more parameters that can be extracted from a request (i.e., [_impl FromRequest_][implfromrequest]) and returns a type that can be converted into an HttpResponse (i.e., [_impl Responder_][respondertrait]).
2019-06-25 05:36:32 +02:00
2022-02-26 05:41:49 +01:00
Request handling happens in two stages. First the handler object is called, returning any object that implements the [_Responder_][respondertrait] trait. Then, `respond_to()` is called on the returned object, converting itself to a `HttpResponse` or `Error` .
2019-06-25 05:36:32 +02:00
2022-02-26 05:41:49 +01:00
By default actix-web provides `Responder` implementations for some standard types, such as `&'static str` , `String` , etc.
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01:00
> For a complete list of implementations, check the [_Responder documentation_][responderimpls].
2018-05-22 23:15:08 +02:00
Examples of valid handlers:
```rust
2020-01-02 08:11:12 +01:00
async fn index(_req: HttpRequest) -> & 'static str {
2018-05-22 23:15:08 +02:00
"Hello world!"
}
```
```rust
2020-01-02 08:11:12 +01:00
async fn index(_req: HttpRequest) -> String {
2018-05-22 23:15:08 +02:00
"Hello world!".to_owned()
}
```
2022-02-26 05:41:49 +01:00
You can also change the signature to return `impl Responder` which works well if more complex types are involved.
2018-05-22 23:15:08 +02:00
```rust
2020-01-02 08:11:12 +01:00
async fn index(_req: HttpRequest) -> impl Responder {
2020-11-27 02:10:05 +01:00
web::Bytes::from_static(b"Hello world!")
2018-05-22 23:15:08 +02:00
}
```
2019-06-20 08:04:22 +02:00
```rust
2020-01-02 08:11:12 +01:00
async fn index(req: HttpRequest) -> Box< Future < Item = HttpResponse, Error = Error > > {
2018-05-22 23:15:08 +02:00
...
}
```
## Response with custom type
To return a custom type directly from a handler function, the type needs to implement the `Responder` trait.
Let's create a response for a custom type that serializes to an `application/json` response:
2019-06-20 08:04:22 +02:00
{{< include-example example = "responder-trait" file = "main.rs" section = "responder-trait" > }}
2018-05-22 23:15:08 +02:00
2020-01-02 08:11:12 +01:00
## Streaming response body
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01:00
Response body can be generated asynchronously. In this case, body must implement the stream trait `Stream<Item=Bytes, Error=Error>` , i.e.:
2018-05-22 23:15:08 +02:00
2019-06-20 08:04:22 +02:00
{{< include-example example = "async-handlers" file = "stream.rs" section = "stream" > }}
2018-05-22 23:15:08 +02:00
## Different return types (Either)
2022-02-26 05:41:49 +01:00
Sometimes, you need to return different types of responses. For example, you can error check and return errors, return async responses, or any result that requires two different types.
2018-05-22 23:15:08 +02:00
2022-02-26 05:41:49 +01:00
For this case, the [Either][either] type can be used. `Either` allows combining two different responder types into a single type.
2018-05-22 23:15:08 +02:00
2019-06-20 08:04:22 +02:00
{{< include-example example = "either" file = "main.rs" section = "either" > }}
2019-06-25 05:36:32 +02:00
2020-09-12 17:21:54 +02:00
[implfromrequest]: https://docs.rs/actix-web/3/actix_web/trait.FromRequest.html
[respondertrait]: https://docs.rs/actix-web/3/actix_web/trait.Responder.html
[responderimpls]: https://docs.rs/actix-web/3/actix_web/trait.Responder.html#foreign-impls
[either]: https://docs.rs/actix-web/3/actix_web/enum.Either.html