Struct worker::Response

pub struct Response { /* private fields */ }

A Response representation for working with or returning a response to a Request.

Implementations

impl Response

pub fn from_json<B: Serialize>(value: &B) -> Result<Self>

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(html: impl AsRef<str>) -> Result<Self>

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(bytes: Vec<u8>) -> Result<Self>

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

pub fn from_body(body: ResponseBody) -> Result<Self>

Create a Response using a ResponseBody variant. 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 from_websocket(websocket: WebSocket) -> Result<Self>

Create a Response using a WebSocket client. Configures the browser to switch protocols (using status code 101) and returns the websocket.

pub fn from_stream<S>(stream: S) -> Result<Self>

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(body: impl Into<String>) -> Result<Self>

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

pub fn empty() -> Result<Self>

Create an empty Response with a 200 status code.

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

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.

pub fn redirect(url: Url) -> Result<Self>

Create a Response which redirects to the specified URL with default status_code of 302

pub fn redirect_with_status(url: Url, status_code: u16) -> Result<Self>

Create a Response which redirects to the specified URL with a custom status_code

pub fn status_code(&self) -> u16

Get the HTTP Status code of this Response.

pub fn body(&self) -> &ResponseBody

Access this response’s body

pub async fn text(&mut self) -> Result<String>

Access this response’s body as plaintext.

pub async fn json<B: DeserializeOwned>(&mut self) -> Result<B>

Access this response’s body encoded as JSON.

pub async fn bytes(&mut self) -> Result<Vec<u8>>

Access this response’s body encoded as raw bytes.

pub fn stream(&mut self) -> Result<ByteStream>

Access this response’s body as a Stream of bytes.

pub fn websocket(self) -> Option<WebSocket>

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

Set this response’s Headers.

pub fn with_status(self, status_code: 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_cors(self, cors: &Cors) -> Result<Self>

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

use worker::*;
fn fetch() -> worker::Result<Response> {
    let cors = Cors::default();
    Response::empty()?
        .with_cors(&cors)
}

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

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

pub fn headers(&self) -> &Headers

Read the Headers on this response.

pub fn headers_mut(&mut self) -> &mut Headers

Get a mutable reference to the Headers on this response.

pub fn cloned(&mut self) -> Result<Self>

Clones the response so it can be used multiple times.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl From<&Response> for Response

fn from(res: &Response) -> Self

Converts to this type from the input type.

impl From<Response> for Response

fn from(res: Response) -> Self

Converts to this type from the input type.

impl From<Response> for Response<Body>

fn from(resp: Response) -> Response<Body>

Converts to this type from the input type.

impl From<Response> for Response

fn from(res: Response) -> Self

Converts to this type from the input type.

impl<B: Body<Data = Bytes> + 'static> TryFrom<Response<B>> for Response

type Error = Error

The type returned in the event of a conversion error.

fn try_from(res: Response<B>) -> Result<Self>

Performs the conversion.

impl TryFrom<Response> for HttpResponse

type Error = Error

The type returned in the event of a conversion error.

fn try_from(res: Response) -> Result<HttpResponse>

Performs the conversion.