Skip to main content

ResponseBuilder

Struct ResponseBuilder

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.

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

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

pub fn extensions(&self) -> Ref<'_, Extensions>

Responses extensions.

pub fn extensions_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

Converts to this type from the input type.

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

Convert Response to a ResponseBuilder. Body get dropped.

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

Converts to this type from the input type.

impl From<ResponseBuilder> for Response

fn from(builder: ResponseBuilder) -> Self

Converts to this type from the input type.

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

async fn respond_to(self, _: &HttpRequest) -> Response

Convert itself to http response.

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

impl !RefUnwindSafe for ResponseBuilder

impl !Send for ResponseBuilder

impl !Sync for ResponseBuilder

impl Unpin for ResponseBuilder

impl UnsafeUnpin for ResponseBuilder

impl !UnwindSafe for ResponseBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same 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.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.