Struct ResponseBuilder

Source

pub struct ResponseBuilder { /* private fields */ }

Expand description

An HTTP response builder

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

Header conversion errors are stored by the builder. A later call to ResponseBuilder::body, ResponseBuilder::message_body, ResponseBuilder::streaming, ResponseBuilder::json, or ResponseBuilder::build converts the stored error into an error response. After an error is stored, subsequent configuration does not affect the returned response.

Implementations§

Source §

impl ResponseBuilder

Source

pub fn new(status: StatusCode) -> Self

Creates a response builder with the supplied status.

Source

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

Sets the response status code.

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")
        .build()
}

Source

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

Sets a header, replacing any existing values with the same name.

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")
        .build()
}

Source

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

Sets a custom HTTP/1 reason phrase.

Source

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

Marks the response connection as persistent.

Has no effect if the response connection is already marked to be closed, see ResponseHead::set_connection_type().

Source

pub fn upgrade<V>(&mut self, value: V) -> &mut Self
where HeaderValue: TryFrom<V>, <HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

Marks the connection as upgraded and sets the Upgrade header.

Source

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

Forces the connection to close after this response.

Source

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

Disable chunked transfer encoding for HTTP/1.1 streaming responses.

Source

pub fn content_type<V>(&mut self, value: V) -> &mut Self
where HeaderValue: TryFrom<V>, <HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

Sets the Content-Type header.

Source

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

Appends a Content-Length header.

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)
        )
        .build()
}

Source

pub fn del_cookie(&mut self, cookie: &Cookie<'_>) -> &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.build()
}

Source