Struct ResponseBuilder

pub struct ResponseBuilder { /* private fields */ }

An HTTP response builder.

Used to construct an instance of Response using a builder pattern. Response builders are often created using Response::build.

Examples

use actix_http::{Response, ResponseBuilder, StatusCode, body, header};

let mut res: Response<_> = Response::build(StatusCode::OK)
    .content_type(mime::APPLICATION_JSON)
    .insert_header((header::SERVER, "my-app/1.0"))
    .append_header((header::SET_COOKIE, "a=1"))
    .append_header((header::SET_COOKIE, "b=2"))
    .body("1234");

assert_eq!(res.status(), StatusCode::OK);

assert!(res.headers().contains_key("server"));
assert_eq!(res.headers().get_all("set-cookie").count(), 2);

assert_eq!(body::to_bytes(res.into_body()).await.unwrap(), &b"1234"[..]);

Implementations

impl ResponseBuilder

pub fn new(status: StatusCode) -> Self

Create response builder

Examples

use actix_http::{Response, ResponseBuilder, StatusCode};
let res: Response<_> = ResponseBuilder::default().finish();
assert_eq!(res.status(), StatusCode::OK);

pub fn status(&mut self, status: StatusCode) -> &mut Self

Set HTTP status code of this response.

Examples

use actix_http::{ResponseBuilder, StatusCode};
let res = ResponseBuilder::default().status(StatusCode::NOT_FOUND).finish();
assert_eq!(res.status(), StatusCode::NOT_FOUND);

pub fn insert_header(&mut self, header: impl TryIntoHeaderPair) -> &mut Self

Insert a header, replacing any that were set with an equivalent field name.

Examples

use actix_http::{ResponseBuilder, header};

let res = ResponseBuilder::default()
    .insert_header((header::CONTENT_TYPE, mime::APPLICATION_JSON))
    .insert_header(("X-TEST", "value"))
    .finish();

assert!(res.headers().contains_key("content-type"));
assert!(res.headers().contains_key("x-test"));

pub fn append_header(&mut self, header: impl TryIntoHeaderPair) -> &mut Self

Append a header, keeping any that were set with an equivalent field name.

Examples

use actix_http::{ResponseBuilder, header};

let res = ResponseBuilder::default()
    .append_header((header::CONTENT_TYPE, mime::APPLICATION_JSON))
    .append_header(("X-TEST", "value1"))
    .append_header(("X-TEST", "value2"))
    .finish();

assert_eq!(res.headers().get_all("content-type").count(), 1);
assert_eq!(res.headers().get_all("x-test").count(), 2);

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

Set the custom reason for the response.

pub fn keep_alive(&mut self) -> &mut Self

Set connection type to KeepAlive

pub fn upgrade<V>(&mut self, value: V) -> &mut Self

where V: TryIntoHeaderValue,

Set connection type to Upgrade.

pub fn force_close(&mut self) -> &mut Self

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

pub fn no_chunking(&mut self, len: u64) -> &mut Self

Disable chunked transfer encoding for HTTP/1.1 streaming responses.

pub fn content_type<V>(&mut self, value: V) -> &mut Self

where V: TryIntoHeaderValue,

Set response content type.

pub fn body<B>(&mut self, body: B) -> Response<EitherBody<B>>

where B: MessageBody + 'static,

Generate response with a wrapped body.

This ResponseBuilder will be left in a useless state.

pub fn message_body<B>(&mut self, body: B) -> Result<Response<B>, Error>

Generate response with a body.

This ResponseBuilder will be left in a useless state.

pub fn finish(&mut self) -> Response<EitherBody<()>>

Generate response with an empty body.

This ResponseBuilder will be left in a useless state.

pub fn take(&mut self) -> ResponseBuilder

Create an owned ResponseBuilder, leaving the original in a useless state.

Trait Implementations

impl Debug for ResponseBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ResponseBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a ResponseHead> for ResponseBuilder

Convert ResponseHead to a ResponseBuilder

fn from(head: &'a ResponseHead) -> ResponseBuilder

Converts to this type from the input type.

impl<B> From<Response<B>> for ResponseBuilder

Convert Response to a ResponseBuilder. Body get dropped.

fn from(res: Response<B>) -> ResponseBuilder

Converts to this type from the input type.

impl From<ResponseBuilder> for Response<EitherBody<()>>

fn from(builder: ResponseBuilder) -> Self

Converts to this type from the input type.