[−][src]Struct actix_web::dev::HttpResponseBuilder

pub struct HttpResponseBuilder { /* fields omitted */ }

An HTTP response builder

This type can be used to construct an instance of HttpResponse through a builder-like pattern.

Methods

`impl HttpResponseBuilder`[src]

`pub fn new(status: StatusCode) -> HttpResponseBuilder`[src]

Create a new HTTP response builder with specific status.

`pub fn status(&mut self, status: StatusCode) -> &mut Self`[src]

Set HTTP status code of this response.

`pub fn version(&mut self, version: Version) -> &mut Self`[src]

Set HTTP version of this response.

By default response's http version depends on request's version.

`pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Self where HeaderName: HttpTryFrom<K>, V: IntoHeaderValue,` [src]

Append a header.

use actix_web::{http, HttpRequest, HttpResponse};

fn index(req: HttpRequest) -> HttpResponse {
    HttpResponse::Ok()
        .header("X-TEST", "value")
        .header(http::header::CONTENT_TYPE, "application/json")
        .finish()
}
fn main() {}

`pub fn insert<K, V>(&mut self, key: K, value: V) -> &mut Self where HeaderName: HttpTryFrom<K>, V: IntoHeaderValue,` [src]

Set or replace a header with a single value.

use actix_web::{http, HttpRequest, HttpResponse};

fn index(req: HttpRequest) -> HttpResponse {
    HttpResponse::Ok()
        .insert("X-TEST", "value")
        .insert(http::header::CONTENT_TYPE, "application/json")
        .finish()
}
fn main() {}

`pub fn remove<K>(&mut self, key: K) -> &mut Self where HeaderName: HttpTryFrom<K>,` [src]

Remove all instances of a header already set on this HttpResponseBuilder.

use actix_web::{http, HttpRequest, HttpResponse};

fn index(req: HttpRequest) -> HttpResponse {
    HttpResponse::Ok()
        .header(http::header::CONTENT_TYPE, "nevermind") // won't be used
        .remove(http::header::CONTENT_TYPE)
        .finish()
}

`pub fn reason(&mut self, reason: &'static str) -> &mut Self`[src]

Set the custom reason for the response.

`pub fn content_encoding(&mut self, enc: ContentEncoding) -> &mut Self`[src]

Set content encoding.

By default ContentEncoding::Auto is used, which automatically negotiates content encoding based on request's Accept-Encoding headers. To enforce specific encoding, use specific ContentEncoding` value.

`pub fn force_close(&mut self) -> &mut Self`[src]

Force close connection, even if it is marked as keep-alive

`pub fn chunked(&mut self) -> &mut Self`[src]

Enables automatic chunked transfer encoding

`pub fn no_chunking(&mut self) -> &mut Self`[src]

Force disable chunked encoding

`pub fn content_type<V>(&mut self, value: V) -> &mut Self where HeaderValue: HttpTryFrom<V>,` [src]

Set response content type

`pub fn content_length(&mut self, len: u64) -> &mut Self`[src]

Set content length

`pub fn cookie<'c>(&mut self, cookie: Cookie<'c>) -> &mut Self`[src]

Set a cookie

use actix_web::{http, HttpRequest, HttpResponse, Result};

fn index(req: HttpRequest) -> HttpResponse {
    HttpResponse::Ok()
        .cookie(
            http::Cookie::build("name", "value")
                .domain("www.rust-lang.org")
                .path("/")
                .secure(true)
                .http_only(true)
                .finish(),
        )
        .finish()
}

`pub fn del_cookie<'a>(&mut self, cookie: &Cookie<'a>) -> &mut Self`[src]

Remove cookie

use actix_web::{http, HttpRequest, HttpResponse, Result};

fn index(req: &HttpRequest) -> HttpResponse {
    let mut builder = HttpResponse::Ok();

    if let Some(ref cookie) = req.cookie("name") {
        builder.del_cookie(cookie);
    }

    builder.finish()
}

`pub fn if_true<F>(&mut self, value: bool, f: F) -> &mut Self where F: FnOnce(&mut HttpResponseBuilder),` [src]

This method calls provided closure with builder reference if value is true.

`pub fn if_some<T, F>(&mut self, value: Option<T>, f: F) -> &mut Self where F: FnOnce(T, &mut HttpResponseBuilder),` [src]

This method calls provided closure with builder reference if value is Some.

`pub fn write_buffer_capacity(&mut self, cap: usize) -> &mut Self`[src]

Set write buffer capacity

This parameter makes sense only for streaming response or actor. If write buffer reaches specified capacity, stream or actor get paused.

Default write buffer capacity is 64kb