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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set HTTP status code of this response.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn version(&mut self, version: Version) -> &mut Self

Set HTTP version of this response.

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set a header.

use http::header;

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set the custom reason for the response.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn content_encoding(&mut self, enc: ContentEncoding) -> &mut Self

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.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Enables automatic chunked transfer encoding

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Force disable chunked encoding

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set response content type

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set content length

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Set a cookie

use actix_web::headers::Cookie;

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Remove cookie, cookie has to be cookie from HttpRequest::cookies() method.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn write_buffer_capacity(&mut self, cap: usize) -> &mut Self

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

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

Set a body and generate HttpResponse.

HttpResponseBuilder can not be used after this call.

pub fn streaming<S>(&mut self, stream: S) -> Result<HttpResponse, HttpError> where
    S: Stream<Item = Bytes, Error = Error> + 'static, 

Set a streaming body and generate HttpResponse.

HttpResponseBuilder can not be used after this call.

pub fn json<T: Serialize>(&mut self, value: T) -> Result<HttpResponse, Error>

Set a json body and generate HttpResponse

HttpResponseBuilder can not be used after this call.

pub fn finish(&mut self) -> Result<HttpResponse, HttpError>

Set an empty body and generate HttpResponse

HttpResponseBuilder can not be used after this call.

pub fn take(&mut self) -> HttpResponseBuilder

This method construct new HttpResponseBuilder

Trait Implementations

impl Debug for HttpResponseBuilder

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl From<HttpResponseBuilder> for HttpResponse

fn from(builder: HttpResponseBuilder) -> Self

Performs the conversion.

impl Responder for HttpResponseBuilder

type Item = HttpResponse

The associated item which can be returned.

type Error = HttpError

The associated error which can be returned.

fn respond_to(self, _: HttpRequest) -> Result<HttpResponse, HttpError>

Convert itself to Reply or Error.