Struct ResponseBuilder

Source

pub struct ResponseBuilder { /* private fields */ }

Expand description

An alternative worker::Response builder.

§Examples

use worker::{Request, RouteContext};
use worker_route::{get, http::ContentType, HttpResponse, http::ResponseBuilder};

#[get("/hello_world")]
fn hello_world(_: Request, _: RouteContext<()>) -> worker::Result<HttpResponse> {
    Ok(ResponseBuilder::init()
        .content_type(&ContentType::plaintext())
        .body(String::from("Hello world.")))
}

Implementations§

Source §

impl ResponseBuilder

Source

pub fn init() -> Self

Constructs a response builder.

Source

pub fn new(status: StatusCode) -> Self

Constructs a response builder with HTTP status.

Source

pub fn content_type(self, v: &ContentType) -> Self

Set response content type.

Source

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

Set response status code.

Source

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

Set response status code.

Source

pub fn body<B: Into<Body>>(self, body: B) -> HttpResponse

Set a body to the response.

Source

pub fn bytes(self, bytes: Vec<u8>) -> HttpResponse

Set the bytes to the response body and content-type as application/octet-stream.

Source

pub fn html(self, html: &str) -> HttpResponse

Set the HTML content to the response body and content-type as text/html.

Source

pub fn json<S: Serialize>(self, value: S) -> HttpResponse

Set the JSON to the response body and content-type as application/json.

Source

pub fn text<T: Into<String>>(self, body: T) -> HttpResponse

Set a body to the response.

Source

pub fn insert_header(&mut self, k: HeaderName, v: HeaderValue) -> &mut Self

Insert a header, replacing any that were set with an equivalent field name.

§Examples

use worker::{Request, RouteContext};
use worker_route::{get, http};
use http::{
    header::{HeaderName, HeaderValue},
    HttpResponse, ResponseBuilder, ContentType,
};

#[get("/hello_world")]
fn hello_world(_: Request, _: RouteContext<()>) -> worker::Result<HttpResponse> {
    let mut res = ResponseBuilder::init();
    res.insert_header(
        HeaderName::from_static("my-header"),
        HeaderValue::from_static("my-value"),
    );

    Ok(res.body(String::from("Hello world.")))
}

§Errors

Errors are returned to the response if the header name or value is invalid or contains empty spaces.

§Panics

Panics if HeaderName or HeaderValue is constructed from using the method from_static and the static string is an invalid header or contains spaces.

Source

pub fn append_header(&mut self, k: HeaderName, v: HeaderValue) -> &mut Self

Append a header, keeping any that were set with an equivalent field name.

§Examples

use http::{
    header::{HeaderName, HeaderValue},
    HttpResponse, ResponseBuilder, ContentType,
};
use worker::{Request, RouteContext};
use worker_route::{get, http};

#[get("/hello_world")]
fn hello_world(_: Request, _: RouteContext<()>) -> worker::Result<HttpResponse> {
    let mut res = ResponseBuilder::init();
    res.append_header(
        HeaderName::from_static("my-header"),
        HeaderValue::from_static("my-value"),
    );

    Ok(res.body(String::from("Hello world.")))
}

§Errors

Errors are returned to the response if the header name or value is invalid or contains empty spaces.

§Panics

Panics if HeaderName or HeaderValue is constructed from using the method from_static and the static string is an invalid header or contains empty spaces.

Source

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

Available on crate feature cookies only.

Add a cookie to this response.

Source

pub fn cookies(&self) -> impl Iterator<Item = Cookie<'_>>

Available on crate feature cookies only.

Get an iterator for the cookies set by this response.

Source

pub fn set_content_type(&mut self, v: &ContentType) -> &mut Self

Set response content type.

Source

pub fn with_cors(&mut self, cors: &Cors) -> &mut Self

Sets this response’s cors headers from the Cors struct.

§Examples

use worker::{Request, Method, RouteContext, Cors};
use worker_route::{get, http::ContentType, HttpResponse, http::ResponseBuilder};

#[get("/hello_world")]
fn hello_world(_: Request, _: RouteContext<()>) -> worker::Result<HttpResponse> {
    let mut res = ResponseBuilder::init();
    let my_cors = Cors::default()
       .with_origins(&["*".to_string()])
       .with_allowed_headers(&["method".to_string(), "origin".to_string()])
       .with_methods([Method::Get, Method::Options])
       .with_max_age(86400);

    res.with_cors(&my_cors);

    Ok(res
        .content_type(&ContentType::plaintext())
        .body(String::from("Hello world.")))
}