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.

Implementations§

Source §

impl ResponseBuilder

Source

pub fn new(status: StatusCode) -> Self

Create response builder

Source

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

Set HTTP status code of this response.

Append a header to existing headers.

use scrappy_http::{http, Request, Response};

fn index(req: Request) -> Response {
    Response::Ok()
        .header("X-TEST", "value")
        .header(http::header::CONTENT_TYPE, "application/json")
        .finish()
}

Source

pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self
where HeaderName: TryFrom<K>, <HeaderName as TryFrom<K>>::Error: Into<HttpError>, V: IntoHeaderValue,

Set a header.

use scrappy_http::{http, Request, Response};

fn index(req: Request) -> Response {
    Response::Ok()
        .set_header("X-TEST", "value")
        .set_header(http::header::CONTENT_TYPE, "application/json")
        .finish()
}

Source

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

Set the custom reason for the response.

Source

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

Set connection type to KeepAlive

Source

pub fn upgrade<V>(&mut self, value: V) -> &mut Self
where V: IntoHeaderValue,

Set connection type to Upgrade

Source

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

Force close connection, even if it is marked as keep-alive

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

Set response content type

Source

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

Set content length

Set a cookie

use scrappy_http::{http, Request, Response};

fn index(req: Request) -> Response {
    Response::Ok()
        .cookie(
            http::Cookie::build("name", "value")
                .domain("www.rust-lang.org")
                .path("/")
                .secure(true)
                .http_only(true)
                .finish(),
        )
        .finish()
}

Source

pub fn del_cookie<'a>(&mut self, cookie: &Cookie<'a>) -> &mut Self

Remove cookie

use scrappy_http::{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()
}

Source

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.

Source

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.

Source

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

Responses extensions

Source

pub fn extensions_mut(&mut self) -> RefMut<'_, Extensions>

Mutable reference to a the response’s extensions

Source