Struct Response 

pub struct Response { /* private fields */ }

An outgoing HTTP response.

Implementations

impl Response

pub fn new(status: StatusCode) -> Self

An empty response with status.

pub fn ok(body: impl Into<Body>) -> Self

200 OK with body.

pub fn no_content() -> Self

204 No Content.

pub fn text(body: impl Into<String>) -> Self

200 OK with a text/plain body.

pub fn html(body: impl Into<String>) -> Self

200 OK with a text/html body.

pub fn json(value: &impl Serialize) -> Self

200 OK with value serialised as JSON.

A value that cannot be serialised becomes a 500 describing the failure, because there is nowhere else for the error to go — the signature has to produce a response.

pub fn created(location: impl AsRef<str>) -> Self

201 Created, with a Location header.

pub fn download(bytes: impl Into<Bytes>, file_name: &str) -> Self

A response that offers the body as a file download.

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

where S: Stream<Item = Result<Bytes, Error>> + Send + 'static,

A streaming response.

pub fn status(&self) -> StatusCode

The status code.

pub fn headers(&self) -> &HeaderMap

The headers.

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

Mutable headers.

pub fn header(&self, name: &str) -> Option<&str>

One header as a string.

pub fn body(&self) -> &Body

The body.

pub fn take_body(&mut self) -> Body

Take the body, leaving an empty one behind.

pub fn extensions(&self) -> &Extensions

Response attributes, keyed by type.

pub fn extensions_mut(&mut self) -> &mut Extensions

Mutable response attributes.

pub fn is_successful(&self) -> bool

Whether the status is 2xx.

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

Replace the status.

pub fn with_body(self, body: impl Into<Body>) -> Self

Replace the body.

pub fn with_header(self, name: &str, value: &str) -> Self

Set a header, replacing any existing one of that name.

An invalid name or value is dropped rather than panicking: header content often comes from configuration or user data, and taking down a request for it would be worse than omitting it.

pub fn with_added_header(self, name: &str, value: &str) -> Self

Append a header, keeping any existing ones of that name.

pub fn with_content_type(self, content_type: &str) -> Self

Set Content-Type.

pub fn with_cookie(self, cookie: &Cookie) -> Self

Attach a Set-Cookie header. Several cookies may be attached.

pub fn without_cookie(self, name: &str) -> Self

Instruct the client to drop a cookie.

pub async fn into_bytes(self) -> Result<Bytes, Error>

The body, collected into bytes.

Consumes the response, because a streaming body can only be read once. For a test, into_string is usually what you want.

pub async fn into_string(self) -> Result<String, Error>

The body, collected and decoded as UTF-8.

The one an assertion reaches for. Without it, reading a body in a test means response.into_http().into_body().collect().await — correct for a server, wrong ergonomics for assert_eq!.

Invalid UTF-8 is replaced rather than refused: a test that is about to print this wants to see what arrived, not an error about it.

pub async fn into_json<T: DeserializeOwned>(self) -> Result<T, Error>

The body, parsed as JSON.

pub fn into_http(self) -> Response<Body>

Convert into an http::Response, ready for the server to write.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Self

Returns the “default value” for a type.

impl From<Error> for Response

fn from(error: Error) -> Self

Converts to this type from the input type.

impl IntoResponse for Response

fn into_response(self) -> Response

Build the response.