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_7.md

83 lines
2.4 KiB
Markdown
Raw Normal View History

2017-12-02 20:41:20 +01:00
# HttpRequest & HttpResponse
2017-12-05 05:38:38 +01:00
## Response
Builder-like patter is used to construct an instance of `HttpResponse`.
`HttpResponse` provides several method that returns `HttpResponseBuilder` instance,
which is implements various convinience methods that helps build response.
Check [documentation](../actix_web/dev/struct.HttpResponseBuilder.html)
for type description. Methods `.body`, `.finish`, `.json` finalizes response creation,
if this methods get call for the same builder instance, builder will panic.
```rust
# extern crate actix_web;
use actix_web::*;
fn index(req: HttpRequest) -> HttpResponse {
HttpResponse::Ok()
.content_encoding(ContentEncoding::Br)
.content_type("plain/text")
.header("X-Hdr", "sample")
.body("data").unwrap()
}
# fn main() {}
```
2017-12-02 20:41:20 +01:00
## Content encoding
2017-12-05 05:38:38 +01:00
Actix automatically *compress*/*decompress* payload. Following codecs are supported:
2017-12-02 20:41:20 +01:00
* Brotli
* Gzip
* Deflate
* Identity
If request headers contains `Content-Encoding` header, request payload get decompressed
according to header value. Multiple codecs are not supported, i.e: `Content-Encoding: br, gzip`.
2017-12-04 05:09:46 +01:00
Response payload get compressed based on *content_encoding* parameter.
By default `ContentEncoding::Auto` is used. If `ContentEncoding::Auto` is selected
then compression depends on request's `Accept-Encoding` header.
`ContentEncoding::Identity` could be used to disable compression.
If other content encoding is selected the compression is enforced for this codec. For example,
to enable `brotli` response's body compression use `ContentEncoding::Br`:
```rust
2017-12-05 01:26:40 +01:00
# extern crate actix_web;
2017-12-04 05:09:46 +01:00
use actix_web::*;
2017-12-04 03:58:15 +01:00
fn index(req: HttpRequest) -> HttpResponse {
HttpResponse::Ok()
.content_encoding(ContentEncoding::Br)
2017-12-04 05:09:46 +01:00
.body("data").unwrap()
2017-12-04 03:58:15 +01:00
}
2017-12-04 05:09:46 +01:00
# fn main() {}
2017-12-04 03:58:15 +01:00
```
2017-12-04 03:51:52 +01:00
## JSON Response
The `Json` type allows you to respond with well-formed JSON data: simply return a value of
type Json<T> where T is the type of a structure to serialize into *JSON*. The
type `T` must implement the `Serialize` trait from *serde*.
```rust
2017-12-05 01:26:40 +01:00
# extern crate actix_web;
2017-12-04 03:51:52 +01:00
#[macro_use] extern crate serde_derive;
use actix_web::*;
#[derive(Serialize)]
struct MyObj {
name: String,
}
fn index(req: HttpRequest) -> Result<Json<MyObj>> {
Ok(Json(MyObj{name: req.match_info().query("name")?}))
}
fn main() {
2017-12-06 20:00:39 +01:00
Application::new("/")
.resource(r"/a/{name}", |r| r.method(Method::GET).f(index))
2017-12-04 03:51:52 +01:00
.finish();
}
```