actix-web/guide/src/qs_7.md

Request & Response

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 for type description. Methods .body, .finish, .json finalizes response creation, if this methods get call for the same builder instance, builder will panic.

# extern crate actix_web;
use actix_web::*;
use actix_web::headers::ContentEncoding;

fn index(req: HttpRequest) -> HttpResponse {
    HttpResponse::Ok()
        .content_encoding(ContentEncoding::Br)
        .content_type("plain/text")
        .header("X-Hdr", "sample")
        .body("data").unwrap()
}
# fn main() {}

Content encoding

Actix automatically compress/decompress payload. Following codecs are supported:

• 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.

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:

# extern crate actix_web;
use actix_web::*;
use actix_web::headers::ContentEncoding;

fn index(req: HttpRequest) -> HttpResponse {
    HttpResponse::Ok()
        .content_encoding(ContentEncoding::Br)
        .body("data").unwrap()
}
# fn main() {}

JSON Response

The Json type allows you to respond with well-formed JSON data: simply return a value of type Json where T is the type of a structure to serialize into JSON. The type T must implement the Serialize trait from serde.

# extern crate actix_web;
#[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() {
    Application::new()
        .resource(r"/a/{name}", |r| r.method(Method::GET).f(index))
        .finish();
}

Chunked transfer encoding

Actix automatically decode chunked encoding. HttpRequest::payload() already contains decoded bytes stream. If request payload compressed with one of supported compression codecs (br, gzip, deflate) bytes stream get decompressed.

Chunked encoding on response could be enabled with HttpResponseBuilder::chunked() method. But this takes effect only for Body::Streaming(BodyStream) or Body::StreamingContext bodies. Also if response payload compression is enabled and streaming body is used, chunked encoding get enabled automatically.

Enabling chunked encoding for HTTP/2.0 responses is forbidden.

# extern crate actix_web;
use actix_web::*;
use actix_web::headers::ContentEncoding;

fn index(req: HttpRequest) -> HttpResponse {
    HttpResponse::Ok()
        .chunked()
        .body(Body::Streaming(Payload::empty().stream())).unwrap()
}
# fn main() {}

Cookies

[WIP]

Multipart body

[WIP]

Urlencoded body

[WIP]

Streaming request

[WIP]