Struct actix_web::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.

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<H>(&mut self, header: H) -> &mut Self where
    H: IntoHeaderPair, 

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<H>(&mut self, header: H) -> &mut Self where
    H: IntoHeaderPair, 

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 set_header<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: TryInto<HeaderName>,
    K::Error: Into<HttpError>,
    V: IntoHeaderValue, 

👎 Deprecated since 4.0.0:

Replaced with insert_header((key, value)). Will be removed in v5.

Replaced with Self::insert_header().

pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Self where
    K: TryInto<HeaderName>,
    K::Error: Into<HttpError>,
    V: IntoHeaderValue, 

👎 Deprecated since 4.0.0:

Replaced with append_header((key, value)). Will be removed in v5.

Replaced with Self::append_header().

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: IntoHeaderValue, 

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: IntoHeaderValue, 

Set response content type.

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

Set a cookie.

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

HttpResponse::Ok()
    .cookie(
        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<'_>) -> &mut Self

Remove cookie.

A Set-Cookie header is added that will delete a cookie with the same name from the client.

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

async fn handler(req: HttpRequest) -> impl Responder {
    let mut builder = HttpResponse::Ok();

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

    builder.finish()
}

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

Responses extensions

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

Mutable reference to a the response’s extensions

pub fn body<B: Into<AnyBody>>(&mut self, body: B) -> HttpResponse<AnyBody>

Set a body and generate Response.

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 generate Response.

HttpResponseBuilder can not be used after this call.

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

Set a streaming body and generate Response.

HttpResponseBuilder can not be used after this call.

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

Set a json body and generate Response

HttpResponseBuilder can not be used after this call.

pub fn finish(&mut self) -> HttpResponse

Set an empty body and generate Response

HttpResponseBuilder can not be used after this call.

pub fn take(&mut self) -> Self

This method construct new HttpResponseBuilder

Trait Implementations

impl BodyEncoding for HttpResponseBuilder

fn get_encoding(&self) -> Option<ContentEncoding>

Get content encoding

fn encoding(&mut self, encoding: ContentEncoding) -> &mut Self

Set content encoding

impl From<HttpResponseBuilder> for HttpResponse

fn from(builder: HttpResponseBuilder) -> Self

Performs the conversion.

impl From<HttpResponseBuilder> for Response<AnyBody>

fn from(builder: HttpResponseBuilder) -> Self

Performs the conversion.

impl Future for HttpResponseBuilder

type Output = Result<HttpResponse, 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

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

Convert self to HttpResponse.

fn with_status(self, status: StatusCode) -> CustomResponder<Self> where
    Self: Sized, 

Override a status code for a Responder.

fn with_header<H>(self, header: H) -> CustomResponder<Self> where
    Self: Sized,
    H: IntoHeaderPair, 

Insert header to the final response.