Struct ntex::web::HttpResponseBuilder[−][src]

pub struct HttpResponseBuilder { /* fields omitted */ }

Expand description

An HTTP response builder

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

Implementations

impl ResponseBuilder

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.

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

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

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
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

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) -> &mut Self

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

Set response content type

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

Set content length

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

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),

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),

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

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<Body>>(&mut self, body: B) -> Response

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>

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,

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

Set a json body and generate Response

ResponseBuilder can not be used after this call.

pub fn finish(&mut self) -> Response

Set an empty body and generate Response

ResponseBuilder can not be used after this call.

pub fn take(&mut self) -> ResponseBuilder

This method construct new ResponseBuilder

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 Debug for ResponseBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'a> From<&'a ResponseHead> for ResponseBuilder

Convert ResponseHead to a ResponseBuilder

fn from(head: &'a ResponseHead) -> ResponseBuilder

Performs the conversion.

impl<B> From<Response<B>> for ResponseBuilder

Convert Response to a ResponseBuilder. Body get dropped.

fn from(res: Response<B>) -> ResponseBuilder

Performs the conversion.

impl From<ResponseBuilder> for Response

fn from(builder: ResponseBuilder) -> Self

Performs the conversion.

impl<Err: ErrorRenderer> Responder<Err> for ResponseBuilder

type Error = Err::Container

The associated error which can be returned.

type Future = Ready<Response>

The future response value.

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

Convert itself to AsyncResult or Error.

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

Override a status code for a Responder. Read more

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

Add header to the Responder’s response. Read more

Auto Trait Implementations

impl !RefUnwindSafe for ResponseBuilder

impl !Send for ResponseBuilder

impl !Sync for ResponseBuilder

impl Unpin for ResponseBuilder

impl !UnwindSafe for ResponseBuilder

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
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>

Performs the conversion.

impl<T, U> TryInto<U> for T where
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>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more