Struct actix_web::dev::HttpResponseBuilder
[−]
[src]
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[src]
fn version(&mut self, version: Version) -> &mut Self[src]
Set HTTP version of this response.
By default response's http version depends on request's version.
fn header<K, V>(&mut self, key: K, value: V) -> &mut Self where
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>, [src]
HeaderName: HttpTryFrom<K>,
HeaderValue: HttpTryFrom<V>,
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() {}
fn reason(&mut self, reason: &'static str) -> &mut Self[src]
Set the custom reason for the response.
fn content_encoding(&mut self, enc: ContentEncoding) -> &mut Self[src]
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.
fn force_close(&mut self) -> &mut Self[src]
Force close connection, even if it is marked as keep-alive
fn chunked(&mut self) -> &mut Self[src]
Enables automatic chunked transfer encoding
fn no_chunking(&mut self) -> &mut Self[src]
Force disable chunked encoding
fn content_type<V>(&mut self, value: V) -> &mut Self where
HeaderValue: HttpTryFrom<V>, [src]
HeaderValue: HttpTryFrom<V>,
Set response content type
fn content_length(&mut self, len: u64) -> &mut Self[src]
Set content length
[src]
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() {}
[src]
Remove cookie, cookie has to be cookie from HttpRequest::cookies() method.
fn if_true<F>(&mut self, value: bool, f: F) -> &mut Self where
F: FnOnce(&mut HttpResponseBuilder), [src]
F: FnOnce(&mut HttpResponseBuilder),
This method calls provided closure with builder reference if value is true.
fn if_some<T, F>(&mut self, value: Option<T>, f: F) -> &mut Self where
F: FnOnce(T, &mut HttpResponseBuilder), [src]
F: FnOnce(T, &mut HttpResponseBuilder),
This method calls provided closure with builder reference if value is Some.
fn body<B: Into<Body>>(&mut self, body: B) -> Result<HttpResponse, HttpError>[src]
Set a body and generate HttpResponse.
HttpResponseBuilder can not be used after this call.
fn json<T: Serialize>(&mut self, value: T) -> Result<HttpResponse, Error>[src]
Set a json body and generate HttpResponse
HttpResponseBuilder can not be used after this call.
fn finish(&mut self) -> Result<HttpResponse, HttpError>[src]
Set an empty body and generate HttpResponse
HttpResponseBuilder can not be used after this call.
fn take(&mut self) -> HttpResponseBuilder[src]
This method construct new HttpResponseBuilder
Trait Implementations
impl Debug for HttpResponseBuilder[src]
impl Responder for HttpResponseBuilder[src]
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>[src]
Convert itself to Reply or Error.