Struct actix_web::HttpResponseBuilder

pub struct HttpResponseBuilder { /* private fields */ }

An HTTP response builder.

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

Implementations

impl HttpResponseBuilder

pub fn new(status: StatusCode) -> Self

Create response builder

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

Set HTTP status code of this response.

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

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

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

HttpResponse::Ok()
    .insert_header(header::ContentType(mime::APPLICATION_JSON))
    .insert_header(("X-TEST", "value"))
    .finish();

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

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

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

HttpResponse::Ok()
    .append_header(header::ContentType(mime::APPLICATION_JSON))
    .append_header(("X-TEST", "value1"))
    .append_header(("X-TEST", "value2"))
    .finish();

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 Selfwhere
    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 Selfwhere
    V: TryIntoHeaderValue,

Set response content type.

pub fn cookie(&mut self, cookie: Cookie<'_>) -> &mut Self

Add a cookie to the response.

To send a “removal” cookie, call .make_removal() on the given cookie. See HttpResponse::add_removal_cookie() to learn more.

Examples

Send a new cookie:

use actix_web::{HttpResponse, cookie::Cookie};

let res = HttpResponse::Ok()
    .cookie(
        Cookie::build("name", "value")
            .domain("www.rust-lang.org")
            .path("/")
            .secure(true)
            .http_only(true)
            .finish(),
    )
    .finish();

Send a removal cookie:

use actix_web::{HttpResponse, cookie::Cookie};

// the name, domain and path match the cookie created in the previous example
let mut cookie = Cookie::build("name", "value-does-not-matter")
    .domain("www.rust-lang.org")
    .path("/")
    .finish();
cookie.make_removal();

let res = HttpResponse::Ok()
    .cookie(cookie)
    .finish();

pub fn extensions(&self) -> Ref<'_, Extensions>

Returns a reference to the response-local data/extensions container.

pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>

Returns a mutable reference to the response-local data/extensions container.

pub fn body<B>(&mut self, body: B) -> HttpResponse<BoxBody>where
    B: MessageBody + 'static,

Set a body and build the HttpResponse.

Unlike message_body, errors are converted into error responses immediately.

HttpResponseBuilder can not be used after this call.

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

Set a body and build the HttpResponse.

HttpResponseBuilder can not be used after this call.

pub fn streaming<S, E>(&mut self, stream: S) -> HttpResponsewhere
    S: Stream<Item = Result<Bytes, E>> + 'static,
    E: Into<Box<dyn Error>> + 'static,

Set a streaming body and build the HttpResponse.

HttpResponseBuilder can not be used after this call.

pub fn json(&mut self, value: impl Serialize) -> HttpResponse

Set a JSON body and build the HttpResponse.

HttpResponseBuilder can not be used after this call.

pub fn finish(&mut self) -> HttpResponse

Set an empty body and build the HttpResponse.

HttpResponseBuilder can not be used after this call.

pub fn take(&mut self) -> Self

This method construct new HttpResponseBuilder

Trait Implementations

impl From<HttpResponseBuilder> for HttpResponse

fn from(builder: HttpResponseBuilder) -> Self

Converts to this type from the input type.

impl From<HttpResponseBuilder> for Response<BoxBody>

fn from(builder: HttpResponseBuilder) -> Self

Converts to this type from the input type.

impl Future for HttpResponseBuilder

type Output = Result<HttpResponse<BoxBody>, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl Responder for HttpResponseBuilder

type Body = BoxBody

fn respond_to(self, _: &HttpRequest) -> HttpResponse<Self::Body>

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>where
    Self: Sized,

Wraps responder to allow alteration of its response.