Struct ResponseBuilder

pub struct ResponseBuilder { /* private fields */ }

Implementations

impl ResponseBuilder

pub fn new() -> Self

pub fn with_status(self, status: u16) -> Self

Set this response’s status code. The Workers platform will reject HTTP status codes outside the range of 200..599 inclusive, and will throw a JavaScript RangeError, returning a response with an HTTP 500 status code.

pub fn with_headers(self, headers: Headers) -> Self

Set this response’s Headers.

pub fn with_header(self, key: &str, value: &str) -> Result<Self>

Set a single header on this response.

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

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

let cors = Cors::default();
ResponseBuilder::new()
    .with_cors(&cors)
    .empty()

pub fn with_websocket(self, websocket: WebSocket) -> Self

Sets this response’s webSocket option. This will require a status code 101 to work.

pub fn with_encode_body(self, encode_body: EncodeBody) -> Self

Set this response’s encodeBody option. In most cases this is not needed, but it can be set to “manual” to return already compressed data to the user without re-compression.

pub fn with_cf<T: Serialize>(self, cf: T) -> Result<Self>

Set this response’s cf options. This is used by consumers of the Response for informational purposes and has no impact on Workers behavior.

pub fn fixed(self, body: Vec<u8>) -> Response

Build a response with a fixed-length body.

pub fn stream(self, stream: ReadableStream) -> Response

Build a response with a stream body.

pub fn body(self, body: ResponseBody) -> Response

Build a response from a ResponseBody.

pub fn empty(self) -> Response

Build a response with an empty body.

pub fn from_json<B: Serialize>(self, value: &B) -> Result<Response>

Create a Response using B as the body encoded as JSON. Sets the associated Content-Type header for the Response as application/json.

pub fn from_html(self, html: impl AsRef<str>) -> Result<Response>

Create a Response using the body encoded as HTML. Sets the associated Content-Type header for the Response as text/html; charset=utf-8.

pub fn from_bytes(self, bytes: Vec<u8>) -> Result<Response>

Create a Response using unprocessed bytes provided. Sets the associated Content-Type header for the Response as application/octet-stream.

pub fn from_stream<S>(self, stream: S) -> Result<Response>

where S: TryStream + 'static, S::Ok: Into<Vec<u8>>, S::Error: Into<Error>,

Create a Response using a Stream for the body. Sets a status code of 200 and an empty set of Headers. Modify the Response with methods such as with_status and with_headers.

pub fn ok(self, body: impl Into<String>) -> Result<Response>

Create a Response using unprocessed text provided. Sets the associated Content-Type header for the Response as text/plain; charset=utf-8.

pub fn error(self, msg: impl Into<String>, status: u16) -> Result<Response>

A helper method to send an error message to a client. Will return Err if the status code provided is outside the valid HTTP error range of 400-599.

Trait Implementations

impl Clone for ResponseBuilder

fn clone(&self) -> ResponseBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResponseBuilder

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

Formats the value using the given formatter.

impl From<ResponseBuilder> for ResponseInit

fn from(init: ResponseBuilder) -> Self

Converts to this type from the input type.