[−][src]Struct ntex::http::ResponseBuilder
An HTTP response builder
This type can be used to construct an instance of Response
through a
builder-like pattern.
Implementations
impl ResponseBuilder
[src]
pub fn new(status: StatusCode) -> Self
[src]
Create response builder
pub fn status(&mut self, status: StatusCode) -> &mut Self
[src]
Set HTTP status code of this response.
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Self where
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
[src]
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
Append a header to existing headers.
use ntex::http::{header, Request, Response}; fn index(req: Request) -> Response { Response::Ok() .header("X-TEST", "value") .header(header::CONTENT_TYPE, "application/json") .finish() }
pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self where
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
[src]
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
Set a header.
use ntex::http::{header, Request, Response}; fn index(req: Request) -> Response { Response::Ok() .set_header("X-TEST", "value") .set_header(header::CONTENT_TYPE, "application/json") .finish() }
pub fn reason(&mut self, reason: &'static str) -> &mut Self
[src]
Set the custom reason for the response.
pub fn keep_alive(&mut self) -> &mut Self
[src]
Set connection type to KeepAlive
pub fn upgrade<V>(&mut self, value: V) -> &mut Self where
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
[src]
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
Set connection type to Upgrade
pub fn force_close(&mut self) -> &mut Self
[src]
Force close connection, even if it is marked as keep-alive
pub fn no_chunking(&mut self) -> &mut Self
[src]
Disable chunked transfer encoding for HTTP/1.1 streaming responses.
pub fn content_type<V>(&mut self, value: V) -> &mut Self where
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
[src]
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
Set response content type
pub fn content_length(&mut self, len: u64) -> &mut Self
[src]
Set content length
pub fn cookie<'c>(&mut self, cookie: Cookie<'c>) -> &mut Self
[src]
Set a cookie
use coo_kie as cookie; use ntex::http::{Request, Response}; fn index(req: Request) -> Response { Response::Ok() .cookie( cookie::Cookie::build("name", "value") .domain("www.rust-lang.org") .path("/") .secure(true) .http_only(true) .finish(), ) .finish() }
pub fn del_cookie<'a>(&mut self, cookie: &Cookie<'a>) -> &mut Self
[src]
Remove cookie
use ntex::http::{Request, Response, HttpMessage}; fn index(req: Request) -> Response { let mut builder = Response::Ok(); if let Some(ref cookie) = req.cookie("name") { builder.del_cookie(cookie); } builder.finish() }
pub fn if_true<F>(&mut self, value: bool, f: F) -> &mut Self where
F: FnOnce(&mut ResponseBuilder),
[src]
F: FnOnce(&mut ResponseBuilder),
This method calls provided closure with builder reference if value is true.
pub fn if_some<T, F>(&mut self, value: Option<T>, f: F) -> &mut Self where
F: FnOnce(T, &mut ResponseBuilder),
[src]
F: FnOnce(T, &mut ResponseBuilder),
This method calls provided closure with builder reference if value is Some.
pub fn extensions(&self) -> Ref<'_, Extensions>
[src]
Responses extensions
pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>
[src]
Mutable reference to a the response's extensions
pub fn body<B: Into<Body>>(&mut self, body: B) -> Response
[src]
Set a body and generate Response
.
ResponseBuilder
can not be used after this call.
pub fn message_body<B>(&mut self, body: B) -> Response<B>
[src]
Set a body and generate Response
.
ResponseBuilder
can not be used after this call.
pub fn streaming<S, E>(&mut self, stream: S) -> Response where
S: Stream<Item = Result<Bytes, E>> + Unpin + 'static,
E: Error + 'static,
[src]
S: Stream<Item = Result<Bytes, E>> + Unpin + 'static,
E: Error + 'static,
Set a streaming body and generate Response
.
ResponseBuilder
can not be used after this call.
pub fn json<T: Serialize>(&mut self, value: &T) -> Response
[src]
Set a json body and generate Response
ResponseBuilder
can not be used after this call.
pub fn finish(&mut self) -> Response
[src]
Set an empty body and generate Response
ResponseBuilder
can not be used after this call.
pub fn take(&mut self) -> ResponseBuilder
[src]
This method construct new ResponseBuilder
Trait Implementations
impl BodyEncoding for HttpResponseBuilder
[src]
pub fn get_encoding(&self) -> Option<ContentEncoding>
[src]
pub fn encoding(&mut self, encoding: ContentEncoding) -> &mut Self
[src]
impl Debug for ResponseBuilder
[src]
impl<'a> From<&'a ResponseHead> for ResponseBuilder
[src]
Convert ResponseHead
to a ResponseBuilder
pub fn from(head: &'a ResponseHead) -> ResponseBuilder
[src]
impl<B> From<Response<B>> for ResponseBuilder
[src]
Convert Response
to a ResponseBuilder
. Body get dropped.
pub fn from(res: Response<B>) -> ResponseBuilder
[src]
impl From<ResponseBuilder> for Response
[src]
pub fn from(builder: ResponseBuilder) -> Self
[src]
impl<Err: ErrorRenderer> Responder<Err> for ResponseBuilder
[src]
type Error = Err::Container
The associated error which can be returned.
type Future = Ready<Response>
The future response value.
pub fn respond_to(self, _: &HttpRequest) -> Self::Future
[src]
pub fn with_status(self, status: StatusCode) -> CustomResponder<Self, Err> where
Self: Sized,
[src]
Self: Sized,
pub fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self, Err> where
Self: Sized,
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
[src]
Self: Sized,
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
<HeaderName as TryFrom<K>>::Error: Into<HttpError>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,
Auto Trait Implementations
impl !RefUnwindSafe for ResponseBuilder
[src]
impl !Send for ResponseBuilder
[src]
impl !Sync for ResponseBuilder
[src]
impl Unpin for ResponseBuilder
[src]
impl !UnwindSafe for ResponseBuilder
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,