[−][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 Response through a builder-like pattern.

Methods

`impl ResponseBuilder`[src]

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

Create response builder

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

Set HTTP status code of this response.

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

Append a header to existing headers.

use actix_http::{http, Request, Response};

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

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

Set a header.

use actix_http::{http, Request, Response};

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

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

Set the custom reason for the response.

`pub fn keep_alive(&mut self) -> &mut ResponseBuilder`[src]

Set connection type to KeepAlive

`pub fn upgrade<V>(&mut self, value: V) -> &mut ResponseBuilder where V: IntoHeaderValue,` [src]

Set connection type to Upgrade

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

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

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

Disable chunked transfer encoding for HTTP/1.1 streaming responses.

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

Set response content type

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

Set content length

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

Set a cookie

use actix_http::{http, Request, Response};

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

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

Remove cookie

use actix_http::{http, Request, Response, HttpMessage};

fn index(req: Request) -> Response {
    let mut builder = Response::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 ResponseBuilder where F: FnOnce(&mut ResponseBuilder),` [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 ResponseBuilder where F: FnOnce(T, &mut ResponseBuilder),` [src]

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

`pub fn extensions(&self) -> Ref<Extensions>`[src]

Responses extensions