1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-11-28 10:02:38 +01:00
actix-web/actix-http/src/response.rs

1063 lines
30 KiB
Rust
Raw Normal View History

2018-01-28 07:03:03 +01:00
//! Http response
use std::cell::{Ref, RefMut};
2018-04-14 01:02:01 +02:00
use std::io::Write;
use std::{fmt, io, str};
2017-10-07 06:48:14 +02:00
2018-04-14 01:02:01 +02:00
use bytes::{BufMut, Bytes, BytesMut};
use futures::future::{ok, FutureResult, IntoFuture};
2018-03-08 02:40:13 +01:00
use futures::Stream;
2017-11-27 19:39:47 +01:00
use serde::Serialize;
2018-04-14 01:02:01 +02:00
use serde_json;
2017-12-08 01:40:29 +01:00
2018-12-06 23:32:52 +01:00
use crate::body::{Body, BodyStream, MessageBody, ResponseBody};
2019-03-30 05:13:39 +01:00
use crate::cookie::{Cookie, CookieJar};
2018-12-06 23:32:52 +01:00
use crate::error::Error;
use crate::extensions::Extensions;
2018-12-06 23:32:52 +01:00
use crate::header::{Header, IntoHeaderValue};
use crate::http::header::{self, HeaderName, HeaderValue};
use crate::http::{Error as HttpError, HeaderMap, HttpTryFrom, StatusCode};
use crate::message::{BoxedResponseHead, ConnectionType, ResponseHead};
2018-03-09 19:00:15 +01:00
2017-12-16 01:24:15 +01:00
/// An HTTP Response
2019-02-21 06:02:23 +01:00
pub struct Response<B = Body> {
head: BoxedResponseHead,
2019-02-08 06:16:46 +01:00
body: ResponseBody<B>,
error: Option<Error>,
}
2017-12-16 01:24:15 +01:00
impl Response<Body> {
2017-11-27 07:31:29 +01:00
/// Create http response builder with specific status.
2017-10-11 01:03:32 +02:00
#[inline]
2018-10-05 20:04:59 +02:00
pub fn build(status: StatusCode) -> ResponseBuilder {
2019-02-08 06:16:46 +01:00
ResponseBuilder::new(status)
2017-10-11 01:03:32 +02:00
}
/// Create http response builder
#[inline]
2018-10-05 20:04:59 +02:00
pub fn build_from<T: Into<ResponseBuilder>>(source: T) -> ResponseBuilder {
source.into()
}
2017-10-07 08:14:13 +02:00
/// Constructs a response
2017-10-07 06:48:14 +02:00
#[inline]
2018-10-05 20:04:59 +02:00
pub fn new(status: StatusCode) -> Response {
2019-02-08 06:16:46 +01:00
Response {
head: BoxedResponseHead::new(status),
2019-02-08 06:16:46 +01:00
body: ResponseBody::Body(Body::Empty),
error: None,
}
2017-10-07 06:48:14 +02:00
}
2018-05-29 18:11:10 +02:00
/// Constructs an error response
2017-11-25 18:03:44 +01:00
#[inline]
2018-10-05 20:04:59 +02:00
pub fn from_error(error: Error) -> Response {
let mut resp = error.as_response_error().error_response();
let mut buf = BytesMut::new();
let _ = write!(Writer(&mut buf), "{}", error);
resp.headers_mut()
.insert(header::CONTENT_TYPE, HeaderValue::from_static("text/plain"));
2019-02-08 06:16:46 +01:00
resp.error = Some(error);
resp.set_body(Body::from(buf))
2017-11-25 18:03:44 +01:00
}
2018-11-21 16:49:24 +01:00
/// Convert response to response with body
pub fn into_body<B>(self) -> Response<B> {
2019-02-08 06:16:46 +01:00
let b = match self.body {
2018-11-21 16:49:24 +01:00
ResponseBody::Body(b) => b,
ResponseBody::Other(b) => b,
};
2019-02-08 06:16:46 +01:00
Response {
head: self.head,
error: self.error,
body: ResponseBody::Other(b),
}
2018-11-21 16:49:24 +01:00
}
2018-11-18 05:21:28 +01:00
}
2019-02-21 06:05:37 +01:00
impl<B> Response<B> {
/// Constructs a response with body
#[inline]
pub fn with_body(status: StatusCode, body: B) -> Response<B> {
Response {
head: BoxedResponseHead::new(status),
body: ResponseBody::Body(body),
error: None,
}
}
2018-11-18 05:21:28 +01:00
#[inline]
2018-11-19 23:57:12 +01:00
/// Http message part of the response
pub fn head(&self) -> &ResponseHead {
2019-02-08 06:16:46 +01:00
&*self.head
2018-11-19 23:57:12 +01:00
}
#[inline]
/// Mutable reference to a http message part of the response
pub fn head_mut(&mut self) -> &mut ResponseHead {
2019-02-08 06:16:46 +01:00
&mut *self.head
2018-11-18 05:21:28 +01:00
}
2017-11-25 18:03:44 +01:00
/// The source `error` for this response
#[inline]
pub fn error(&self) -> Option<&Error> {
2019-02-08 06:16:46 +01:00
self.error.as_ref()
2017-11-25 18:03:44 +01:00
}
2018-11-18 05:21:28 +01:00
/// Get the response status code
#[inline]
pub fn status(&self) -> StatusCode {
2019-02-08 06:16:46 +01:00
self.head.status
2018-11-18 05:21:28 +01:00
}
/// Set the `StatusCode` for this response
#[inline]
pub fn status_mut(&mut self) -> &mut StatusCode {
2019-02-08 06:16:46 +01:00
&mut self.head.status
2018-11-18 05:21:28 +01:00
}
/// Get the headers from the response
2017-10-07 06:48:14 +02:00
#[inline]
2017-10-10 08:07:32 +02:00
pub fn headers(&self) -> &HeaderMap {
2019-02-08 06:16:46 +01:00
&self.head.headers
2017-10-07 06:48:14 +02:00
}
/// Get a mutable reference to the headers
2017-10-07 06:48:14 +02:00
#[inline]
2017-10-10 08:07:32 +02:00
pub fn headers_mut(&mut self) -> &mut HeaderMap {
2019-02-08 06:16:46 +01:00
&mut self.head.headers
2017-10-07 06:48:14 +02:00
}
2018-06-12 15:49:07 +02:00
/// Get an iterator for the cookies set by this response
#[inline]
pub fn cookies(&self) -> CookieIter {
CookieIter {
iter: self.head.headers.get_all(header::SET_COOKIE),
2018-06-12 15:49:07 +02:00
}
}
/// Add a cookie to this response
#[inline]
2018-06-14 08:37:19 +02:00
pub fn add_cookie(&mut self, cookie: &Cookie) -> Result<(), HttpError> {
2019-02-08 06:16:46 +01:00
let h = &mut self.head.headers;
2018-06-12 15:49:07 +02:00
HeaderValue::from_str(&cookie.to_string())
2018-06-14 08:37:19 +02:00
.map(|c| {
h.append(header::SET_COOKIE, c);
2018-12-06 23:32:52 +01:00
})
.map_err(|e| e.into())
2018-06-12 15:49:07 +02:00
}
/// Remove all cookies with the given name from this response. Returns
/// the number of cookies removed.
#[inline]
pub fn del_cookie(&mut self, name: &str) -> usize {
2019-02-08 06:16:46 +01:00
let h = &mut self.head.headers;
2018-06-14 08:37:19 +02:00
let vals: Vec<HeaderValue> = h
.get_all(header::SET_COOKIE)
2018-06-12 15:49:07 +02:00
.map(|v| v.to_owned())
.collect();
h.remove(header::SET_COOKIE);
let mut count: usize = 0;
for v in vals {
if let Ok(s) = v.to_str() {
if let Ok(c) = Cookie::parse_encoded(s) {
2018-06-12 15:49:07 +02:00
if c.name() == name {
count += 1;
continue;
}
}
}
h.append(header::SET_COOKIE, v);
}
2018-06-14 08:37:19 +02:00
count
2018-06-12 15:49:07 +02:00
}
2017-10-08 06:48:00 +02:00
/// Connection upgrade status
2018-01-01 02:26:32 +01:00
#[inline]
2017-10-08 06:48:00 +02:00
pub fn upgrade(&self) -> bool {
2019-02-08 06:16:46 +01:00
self.head.upgrade()
2017-10-08 06:48:00 +02:00
}
2017-10-07 06:48:14 +02:00
/// Keep-alive status for this connection
2018-11-19 02:52:56 +01:00
pub fn keep_alive(&self) -> bool {
2019-02-08 06:16:46 +01:00
self.head.keep_alive()
2017-10-07 06:48:14 +02:00
}
2017-10-08 06:48:00 +02:00
2019-03-30 00:29:11 +01:00
/// Responses extensions
#[inline]
pub fn extensions(&self) -> Ref<Extensions> {
self.head.extensions.borrow()
}
/// Mutable reference to a the response's extensions
#[inline]
pub fn extensions_mut(&mut self) -> RefMut<Extensions> {
self.head.extensions.borrow_mut()
}
2017-10-07 08:14:13 +02:00
/// Get body os this response
2018-01-01 02:26:32 +01:00
#[inline]
2019-02-08 06:16:46 +01:00
pub fn body(&self) -> &ResponseBody<B> {
&self.body
2017-10-07 06:48:14 +02:00
}
2017-10-08 06:48:00 +02:00
/// Set a body
pub fn set_body<B2>(self, body: B2) -> Response<B2> {
2019-02-08 06:16:46 +01:00
Response {
head: self.head,
body: ResponseBody::Body(body),
error: None,
}
2017-10-08 06:48:00 +02:00
}
/// Drop request's body
pub fn drop_body(self) -> Response<()> {
2019-02-08 06:16:46 +01:00
Response {
head: self.head,
body: ResponseBody::Body(()),
error: None,
}
}
2017-10-07 08:14:13 +02:00
/// Set a body and return previous body value
pub(crate) fn replace_body<B2>(self, body: B2) -> (Response<B2>, ResponseBody<B>) {
2019-02-08 06:16:46 +01:00
(
Response {
head: self.head,
body: ResponseBody::Body(body),
error: self.error,
},
self.body,
)
2018-06-25 06:10:02 +02:00
}
2019-02-19 02:01:35 +01:00
/// Set a body and return previous body value
pub fn map_body<F, B2>(mut self, f: F) -> Response<B2>
2019-02-19 02:01:35 +01:00
where
F: FnOnce(&mut ResponseHead, ResponseBody<B>) -> ResponseBody<B2>,
{
let body = f(&mut self.head, self.body);
Response {
2019-03-30 05:13:39 +01:00
body,
2019-02-19 02:01:35 +01:00
head: self.head,
error: self.error,
}
}
2019-03-06 06:15:18 +01:00
/// Extract response body
pub fn take_body(&mut self) -> ResponseBody<B> {
self.body.take_body()
}
2017-10-07 06:48:14 +02:00
}
2017-10-11 01:03:32 +02:00
2018-11-19 02:52:56 +01:00
impl<B: MessageBody> fmt::Debug for Response<B> {
2017-11-09 04:31:25 +01:00
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2018-04-14 01:02:01 +02:00
let res = writeln!(
f,
2018-10-05 20:04:59 +02:00
"\nResponse {:?} {}{}",
2019-02-08 06:16:46 +01:00
self.head.version,
self.head.status,
self.head.reason.unwrap_or(""),
2018-04-14 01:02:01 +02:00
);
2018-04-09 23:25:30 +02:00
let _ = writeln!(f, " headers:");
2019-02-08 06:16:46 +01:00
for (key, val) in self.head.headers.iter() {
2018-04-09 23:25:30 +02:00
let _ = writeln!(f, " {:?}: {:?}", key, val);
2017-11-09 04:31:25 +01:00
}
2019-02-08 06:16:46 +01:00
let _ = writeln!(f, " body: {:?}", self.body.length());
2017-11-09 04:31:25 +01:00
res
}
}
impl IntoFuture for Response {
type Item = Response;
type Error = Error;
type Future = FutureResult<Response, Error>;
fn into_future(self) -> Self::Future {
ok(self)
}
}
2018-06-12 15:49:07 +02:00
pub struct CookieIter<'a> {
iter: header::GetAll<'a>,
2018-06-12 15:49:07 +02:00
}
impl<'a> Iterator for CookieIter<'a> {
type Item = Cookie<'a>;
#[inline]
fn next(&mut self) -> Option<Cookie<'a>> {
for v in self.iter.by_ref() {
if let Ok(c) = Cookie::parse_encoded(v.to_str().ok()?) {
2018-06-12 15:49:07 +02:00
return Some(c);
}
}
None
}
}
pub struct Writer<'a>(pub &'a mut BytesMut);
impl<'a> io::Write for Writer<'a> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.0.extend_from_slice(buf);
Ok(buf.len())
}
fn flush(&mut self) -> io::Result<()> {
Ok(())
}
}
2017-10-11 01:03:32 +02:00
/// An HTTP response builder
///
2018-10-05 20:04:59 +02:00
/// This type can be used to construct an instance of `Response` through a
2017-10-11 01:03:32 +02:00
/// builder-like pattern.
2018-10-05 20:04:59 +02:00
pub struct ResponseBuilder {
head: Option<BoxedResponseHead>,
2017-10-22 18:13:29 +02:00
err: Option<HttpError>,
2017-12-14 01:44:35 +01:00
cookies: Option<CookieJar>,
2017-10-11 01:03:32 +02:00
}
2018-10-05 20:04:59 +02:00
impl ResponseBuilder {
#[inline]
2019-02-08 06:16:46 +01:00
/// Create response builder
pub fn new(status: StatusCode) -> Self {
ResponseBuilder {
head: Some(BoxedResponseHead::new(status)),
2019-02-08 06:16:46 +01:00
err: None,
cookies: None,
}
}
2018-03-06 09:43:25 +01:00
/// Set HTTP status code of this response.
#[inline]
pub fn status(&mut self, status: StatusCode) -> &mut Self {
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
parts.status = status;
2018-03-06 09:43:25 +01:00
}
self
}
2018-03-06 04:28:42 +01:00
/// Set a header.
///
2019-03-30 06:06:14 +01:00
/// ```rust
/// use actix_http::{http, Request, Response, Result};
2018-03-06 04:28:42 +01:00
///
2019-03-30 06:06:14 +01:00
/// fn index(req: Request) -> Result<Response> {
2018-10-05 20:04:59 +02:00
/// Ok(Response::Ok()
2018-06-01 18:37:14 +02:00
/// .set(http::header::IfModifiedSince(
/// "Sun, 07 Nov 1994 08:48:37 GMT".parse()?,
/// ))
/// .finish())
2018-03-06 04:28:42 +01:00
/// }
/// fn main() {}
/// ```
#[doc(hidden)]
2018-04-14 01:02:01 +02:00
pub fn set<H: Header>(&mut self, hdr: H) -> &mut Self {
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
2018-03-06 04:28:42 +01:00
match hdr.try_into() {
2018-04-14 01:02:01 +02:00
Ok(value) => {
2019-02-08 06:16:46 +01:00
parts.headers.append(H::name(), value);
2018-04-14 01:02:01 +02:00
}
2018-03-06 04:28:42 +01:00
Err(e) => self.err = Some(e.into()),
}
}
self
}
2018-11-19 23:57:12 +01:00
/// Append a header to existing headers.
2017-12-21 08:19:21 +01:00
///
2019-03-30 06:06:14 +01:00
/// ```rust
/// use actix_http::{http, Request, Response};
2017-12-21 08:19:21 +01:00
///
2019-03-30 06:06:14 +01:00
/// fn index(req: Request) -> Response {
2018-10-05 20:04:59 +02:00
/// Response::Ok()
2017-12-21 08:19:21 +01:00
/// .header("X-TEST", "value")
/// .header(http::header::CONTENT_TYPE, "application/json")
/// .finish()
2017-12-21 08:19:21 +01:00
/// }
/// fn main() {}
/// ```
2017-10-11 01:03:32 +02:00
pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Self
2018-04-14 01:02:01 +02:00
where
HeaderName: HttpTryFrom<K>,
V: IntoHeaderValue,
2017-10-11 01:03:32 +02:00
{
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
2017-10-11 01:03:32 +02:00
match HeaderName::try_from(key) {
2018-04-14 01:02:01 +02:00
Ok(key) => match value.try_into() {
Ok(value) => {
2019-02-08 06:16:46 +01:00
parts.headers.append(key, value);
2017-10-11 01:03:32 +02:00
}
2018-04-14 01:02:01 +02:00
Err(e) => self.err = Some(e.into()),
2017-10-11 01:03:32 +02:00
},
Err(e) => self.err = Some(e.into()),
};
}
self
}
2018-11-19 23:57:12 +01:00
/// Set a header.
///
2019-03-30 06:06:14 +01:00
/// ```rust
/// use actix_http::{http, Request, Response};
2018-11-19 23:57:12 +01:00
///
2019-03-30 06:06:14 +01:00
/// fn index(req: Request) -> Response {
2018-11-19 23:57:12 +01:00
/// Response::Ok()
/// .set_header("X-TEST", "value")
/// .set_header(http::header::CONTENT_TYPE, "application/json")
/// .finish()
/// }
/// fn main() {}
/// ```
pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self
where
HeaderName: HttpTryFrom<K>,
V: IntoHeaderValue,
{
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
2018-11-19 23:57:12 +01:00
match HeaderName::try_from(key) {
Ok(key) => match value.try_into() {
Ok(value) => {
2019-02-08 06:16:46 +01:00
parts.headers.insert(key, value);
2018-11-19 23:57:12 +01:00
}
Err(e) => self.err = Some(e.into()),
},
Err(e) => self.err = Some(e.into()),
};
}
self
}
2017-10-11 01:03:32 +02:00
/// Set the custom reason for the response.
#[inline]
pub fn reason(&mut self, reason: &'static str) -> &mut Self {
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
parts.reason = Some(reason);
2017-10-11 01:03:32 +02:00
}
self
}
2018-11-19 02:52:56 +01:00
/// Set connection type to KeepAlive
2017-12-04 05:47:15 +01:00
#[inline]
2018-11-19 02:52:56 +01:00
pub fn keep_alive(&mut self) -> &mut Self {
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
parts.set_connection_type(ConnectionType::KeepAlive);
2017-10-11 01:03:32 +02:00
}
self
}
2017-10-14 19:01:53 +02:00
/// Set connection type to Upgrade
2017-12-04 05:47:15 +01:00
#[inline]
2018-11-19 23:57:12 +01:00
pub fn upgrade<V>(&mut self, value: V) -> &mut Self
where
V: IntoHeaderValue,
{
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
parts.set_connection_type(ConnectionType::Upgrade);
2018-11-19 02:52:56 +01:00
}
2018-11-19 23:57:12 +01:00
self.set_header(header::UPGRADE, value)
2017-10-14 19:01:53 +02:00
}
/// Force close connection, even if it is marked as keep-alive
2017-12-04 05:47:15 +01:00
#[inline]
2017-10-14 19:01:53 +02:00
pub fn force_close(&mut self) -> &mut Self {
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
parts.set_connection_type(ConnectionType::Close);
2018-11-19 02:52:56 +01:00
}
self
2017-10-14 19:01:53 +02:00
}
2019-02-19 05:24:50 +01:00
/// Disable chunked transfer encoding for HTTP/1.1 streaming responses.
#[inline]
pub fn no_chunking(&mut self) -> &mut Self {
if let Some(parts) = parts(&mut self.head, &self.err) {
2019-03-27 18:38:01 +01:00
parts.no_chunking(true);
2019-02-19 05:24:50 +01:00
}
self
}
2017-10-14 19:01:53 +02:00
/// Set response content type
2017-12-04 05:47:15 +01:00
#[inline]
2017-10-14 19:01:53 +02:00
pub fn content_type<V>(&mut self, value: V) -> &mut Self
2018-04-14 01:02:01 +02:00
where
HeaderValue: HttpTryFrom<V>,
2017-10-14 19:01:53 +02:00
{
2019-02-08 06:16:46 +01:00
if let Some(parts) = parts(&mut self.head, &self.err) {
2017-10-14 19:01:53 +02:00
match HeaderValue::try_from(value) {
2018-04-14 01:02:01 +02:00
Ok(value) => {
2019-02-08 06:16:46 +01:00
parts.headers.insert(header::CONTENT_TYPE, value);
2018-04-14 01:02:01 +02:00
}
2017-10-14 19:01:53 +02:00
Err(e) => self.err = Some(e.into()),
};
}
self
}
2018-01-12 01:22:27 +01:00
/// Set content length
#[inline]
pub fn content_length(&mut self, len: u64) -> &mut Self {
let mut wrt = BytesMut::new().writer();
let _ = write!(wrt, "{}", len);
self.header(header::CONTENT_LENGTH, wrt.get_mut().take().freeze())
}
2017-10-14 19:40:58 +02:00
/// Set a cookie
2017-12-21 08:19:21 +01:00
///
2019-03-30 06:06:14 +01:00
/// ```rust
/// use actix_http::{http, Request, Response};
2017-12-21 08:19:21 +01:00
///
2019-03-30 06:06:14 +01:00
/// fn index(req: Request) -> Response {
2018-10-05 20:04:59 +02:00
/// Response::Ok()
2017-12-21 08:19:21 +01:00
/// .cookie(
2018-03-31 02:31:18 +02:00
/// http::Cookie::build("name", "value")
2017-12-21 08:19:21 +01:00
/// .domain("www.rust-lang.org")
/// .path("/")
/// .secure(true)
/// .http_only(true)
2018-06-01 18:37:14 +02:00
/// .finish(),
/// )
/// .finish()
2017-12-21 08:19:21 +01:00
/// }
/// ```
2017-10-14 19:40:58 +02:00
pub fn cookie<'c>(&mut self, cookie: Cookie<'c>) -> &mut Self {
2017-12-14 01:44:35 +01:00
if self.cookies.is_none() {
let mut jar = CookieJar::new();
jar.add(cookie.into_owned());
self.cookies = Some(jar)
} else {
2018-05-16 01:41:46 +02:00
self.cookies.as_mut().unwrap().add(cookie.into_owned());
2017-10-14 19:40:58 +02:00
}
self
}
/// Remove cookie
///
2019-03-30 06:06:14 +01:00
/// ```rust
/// use actix_http::{http, Request, Response, HttpMessage};
///
2019-03-30 06:06:14 +01:00
/// fn index(req: Request) -> Response {
2018-10-05 20:04:59 +02:00
/// let mut builder = Response::Ok();
///
2018-06-25 06:58:04 +02:00
/// if let Some(ref cookie) = req.cookie("name") {
/// builder.del_cookie(cookie);
/// }
///
/// builder.finish()
/// }
/// ```
2017-10-14 19:40:58 +02:00
pub fn del_cookie<'a>(&mut self, cookie: &Cookie<'a>) -> &mut Self {
if self.cookies.is_none() {
self.cookies = Some(CookieJar::new())
2017-10-14 19:40:58 +02:00
}
let jar = self.cookies.as_mut().unwrap();
let cookie = cookie.clone().into_owned();
jar.add_original(cookie.clone());
jar.remove(cookie);
2017-10-14 19:40:58 +02:00
self
}
2018-04-14 01:02:01 +02:00
/// This method calls provided closure with builder reference if value is
/// true.
2017-10-29 22:51:02 +01:00
pub fn if_true<F>(&mut self, value: bool, f: F) -> &mut Self
2018-04-14 01:02:01 +02:00
where
2018-10-05 20:04:59 +02:00
F: FnOnce(&mut ResponseBuilder),
2017-10-29 22:51:02 +01:00
{
if value {
f(self);
}
self
}
2018-04-14 01:02:01 +02:00
/// This method calls provided closure with builder reference if value is
/// Some.
pub fn if_some<T, F>(&mut self, value: Option<T>, f: F) -> &mut Self
2018-04-14 01:02:01 +02:00
where
2018-10-05 20:04:59 +02:00
F: FnOnce(T, &mut ResponseBuilder),
2018-01-10 08:55:42 +01:00
{
if let Some(val) = value {
f(val, self);
}
self
}
/// Responses extensions
#[inline]
pub fn extensions(&self) -> Ref<Extensions> {
let head = self.head.as_ref().expect("cannot reuse response builder");
head.extensions.borrow()
}
/// Mutable reference to a the response's extensions
#[inline]
pub fn extensions_mut(&mut self) -> RefMut<Extensions> {
let head = self.head.as_ref().expect("cannot reuse response builder");
head.extensions.borrow_mut()
}
#[inline]
2018-10-05 20:04:59 +02:00
/// Set a body and generate `Response`.
2017-12-21 08:19:21 +01:00
///
2018-10-05 20:04:59 +02:00
/// `ResponseBuilder` can not be used after this call.
pub fn body<B: Into<Body>>(&mut self, body: B) -> Response {
self.message_body(body.into())
}
/// Set a body and generate `Response`.
///
/// `ResponseBuilder` can not be used after this call.
pub fn message_body<B>(&mut self, body: B) -> Response<B> {
2018-11-21 16:49:24 +01:00
if let Some(e) = self.err.take() {
return Response::from(Error::from(e)).into_body();
}
2018-11-18 05:21:28 +01:00
2019-02-08 06:16:46 +01:00
let mut response = self.head.take().expect("cannot reuse response builder");
2019-03-23 17:40:20 +01:00
2019-03-30 05:13:39 +01:00
if let Some(ref jar) = self.cookies {
for cookie in jar.delta() {
match HeaderValue::from_str(&cookie.to_string()) {
Ok(val) => response.headers.append(header::SET_COOKIE, val),
2019-03-30 05:13:39 +01:00
Err(e) => return Response::from(Error::from(e)).into_body(),
};
2017-12-13 06:32:58 +01:00
}
2017-10-14 19:40:58 +02:00
}
2018-11-18 05:21:28 +01:00
2019-02-08 06:16:46 +01:00
Response {
head: response,
body: ResponseBody::Body(body),
error: None,
}
2017-10-11 01:03:32 +02:00
}
2017-10-24 08:52:20 +02:00
#[inline]
2018-10-05 20:04:59 +02:00
/// Set a streaming body and generate `Response`.
2018-03-08 02:40:13 +01:00
///
2018-10-05 20:04:59 +02:00
/// `ResponseBuilder` can not be used after this call.
pub fn streaming<S, E>(&mut self, stream: S) -> Response
2018-04-14 01:02:01 +02:00
where
S: Stream<Item = Bytes, Error = E> + 'static,
E: Into<Error> + 'static,
2018-03-08 02:40:13 +01:00
{
self.body(Body::from_message(BodyStream::new(stream)))
2018-03-08 02:40:13 +01:00
}
#[inline]
2018-10-05 20:04:59 +02:00
/// Set a json body and generate `Response`
2017-12-21 08:19:21 +01:00
///
2018-10-05 20:04:59 +02:00
/// `ResponseBuilder` can not be used after this call.
pub fn json<T: Serialize>(&mut self, value: T) -> Response {
2018-08-08 19:11:15 +02:00
self.json2(&value)
}
2018-10-05 20:04:59 +02:00
/// Set a json body and generate `Response`
2018-08-08 19:11:15 +02:00
///
2018-10-05 20:04:59 +02:00
/// `ResponseBuilder` can not be used after this call.
pub fn json2<T: Serialize>(&mut self, value: &T) -> Response {
2018-08-08 19:11:15 +02:00
match serde_json::to_string(value) {
Ok(body) => {
2019-02-08 06:16:46 +01:00
let contains = if let Some(parts) = parts(&mut self.head, &self.err) {
parts.headers.contains_key(header::CONTENT_TYPE)
2018-04-14 01:02:01 +02:00
} else {
true
};
if !contains {
self.header(header::CONTENT_TYPE, "application/json");
}
self.body(Body::from(body))
2018-11-18 05:21:28 +01:00
}
Err(e) => Error::from(e).into(),
2017-11-27 19:39:47 +01:00
}
}
#[inline]
2018-10-05 20:04:59 +02:00
/// Set an empty body and generate `Response`
2017-12-21 08:19:21 +01:00
///
2018-10-05 20:04:59 +02:00
/// `ResponseBuilder` can not be used after this call.
pub fn finish(&mut self) -> Response {
self.body(Body::Empty)
2017-10-24 08:52:20 +02:00
}
2018-01-01 02:26:32 +01:00
2018-10-05 20:04:59 +02:00
/// This method construct new `ResponseBuilder`
pub fn take(&mut self) -> ResponseBuilder {
ResponseBuilder {
2019-02-08 06:16:46 +01:00
head: self.head.take(),
2018-01-01 02:26:32 +01:00
err: self.err.take(),
cookies: self.cookies.take(),
}
}
2017-10-11 01:03:32 +02:00
}
2017-12-16 05:00:12 +01:00
#[inline]
2018-04-14 01:02:01 +02:00
fn parts<'a>(
parts: &'a mut Option<BoxedResponseHead>,
2018-10-30 00:39:46 +01:00
err: &Option<HttpError>,
) -> Option<&'a mut ResponseHead> {
2017-10-11 01:03:32 +02:00
if err.is_some() {
2018-04-14 01:02:01 +02:00
return None;
2017-10-11 01:03:32 +02:00
}
parts.as_mut().map(|r| &mut **r)
2017-10-11 01:03:32 +02:00
}
2017-10-23 07:54:11 +02:00
2019-03-10 23:30:31 +01:00
/// Convert `Response` to a `ResponseBuilder`. Body get dropped.
impl<B> From<Response<B>> for ResponseBuilder {
fn from(res: Response<B>) -> ResponseBuilder {
// If this response has cookies, load them into a jar
let mut jar: Option<CookieJar> = None;
for c in res.cookies() {
if let Some(ref mut j) = jar {
j.add_original(c.into_owned());
} else {
let mut j = CookieJar::new();
j.add_original(c.into_owned());
jar = Some(j);
}
}
ResponseBuilder {
head: Some(res.head),
err: None,
cookies: jar,
}
}
}
/// Convert `ResponseHead` to a `ResponseBuilder`
impl<'a> From<&'a ResponseHead> for ResponseBuilder {
fn from(head: &'a ResponseHead) -> ResponseBuilder {
// If this response has cookies, load them into a jar
let mut jar: Option<CookieJar> = None;
2019-03-23 17:40:20 +01:00
2019-03-30 05:13:39 +01:00
let cookies = CookieIter {
iter: head.headers.get_all(header::SET_COOKIE),
2019-03-30 05:13:39 +01:00
};
for c in cookies {
if let Some(ref mut j) = jar {
j.add_original(c.into_owned());
} else {
let mut j = CookieJar::new();
j.add_original(c.into_owned());
jar = Some(j);
2019-03-10 23:30:31 +01:00
}
}
let mut msg = BoxedResponseHead::new(head.status);
2019-03-10 23:30:31 +01:00
msg.version = head.version;
msg.reason = head.reason;
for (k, v) in &head.headers {
msg.headers.append(k.clone(), v.clone());
}
2019-03-27 18:38:01 +01:00
msg.no_chunking(!head.chunked());
2019-03-10 23:30:31 +01:00
ResponseBuilder {
head: Some(msg),
err: None,
cookies: jar,
}
}
}
impl IntoFuture for ResponseBuilder {
type Item = Response;
type Error = Error;
type Future = FutureResult<Response, Error>;
fn into_future(mut self) -> Self::Future {
ok(self.finish())
}
}
2017-11-28 22:52:53 +01:00
/// Helper converters
2018-10-05 20:04:59 +02:00
impl<I: Into<Response>, E: Into<Error>> From<Result<I, E>> for Response {
2017-11-28 22:52:53 +01:00
fn from(res: Result<I, E>) -> Self {
match res {
Ok(val) => val.into(),
Err(err) => err.into().into(),
}
}
}
2018-10-05 20:04:59 +02:00
impl From<ResponseBuilder> for Response {
fn from(mut builder: ResponseBuilder) -> Self {
builder.finish()
2017-11-29 18:17:00 +01:00
}
}
impl From<&'static str> for Response {
2017-11-29 18:17:00 +01:00
fn from(val: &'static str) -> Self {
2018-10-05 20:04:59 +02:00
Response::Ok()
2018-04-29 18:09:08 +02:00
.content_type("text/plain; charset=utf-8")
.body(val)
2017-11-28 22:52:53 +01:00
}
}
impl From<&'static [u8]> for Response {
2017-11-29 18:17:00 +01:00
fn from(val: &'static [u8]) -> Self {
2018-10-05 20:04:59 +02:00
Response::Ok()
2018-04-29 18:09:08 +02:00
.content_type("application/octet-stream")
.body(val)
2017-11-28 22:52:53 +01:00
}
}
impl From<String> for Response {
2017-11-29 18:17:00 +01:00
fn from(val: String) -> Self {
2018-10-05 20:04:59 +02:00
Response::Ok()
2018-04-29 18:09:08 +02:00
.content_type("text/plain; charset=utf-8")
.body(val)
2017-11-28 22:52:53 +01:00
}
}
impl<'a> From<&'a String> for Response {
fn from(val: &'a String) -> Self {
Response::Ok()
.content_type("text/plain; charset=utf-8")
.body(val)
}
}
impl From<Bytes> for Response {
2017-11-29 18:17:00 +01:00
fn from(val: Bytes) -> Self {
2018-10-05 20:04:59 +02:00
Response::Ok()
2018-04-29 18:09:08 +02:00
.content_type("application/octet-stream")
.body(val)
2017-11-28 22:52:53 +01:00
}
}
impl From<BytesMut> for Response {
2017-11-29 18:17:00 +01:00
fn from(val: BytesMut) -> Self {
2018-10-05 20:04:59 +02:00
Response::Ok()
2018-04-29 18:09:08 +02:00
.content_type("application/octet-stream")
.body(val)
2017-11-28 22:52:53 +01:00
}
}
2017-10-23 07:54:11 +02:00
#[cfg(test)]
mod tests {
use super::*;
2018-12-07 00:03:01 +01:00
use crate::body::Body;
use crate::http::header::{HeaderValue, CONTENT_TYPE, COOKIE, SET_COOKIE};
2018-06-25 06:58:04 +02:00
2017-12-13 20:16:26 +01:00
#[test]
fn test_debug() {
2018-10-05 20:04:59 +02:00
let resp = Response::Ok()
2018-03-08 07:40:46 +01:00
.header(COOKIE, HeaderValue::from_static("cookie1=value1; "))
.header(COOKIE, HeaderValue::from_static("cookie2=value2; "))
.finish();
2017-12-13 20:16:26 +01:00
let dbg = format!("{:?}", resp);
2018-10-05 20:04:59 +02:00
assert!(dbg.contains("Response"));
2017-12-13 20:16:26 +01:00
}
#[test]
fn test_response_cookies() {
2019-03-23 17:40:20 +01:00
use crate::httpmessage::HttpMessage;
let req = crate::test::TestRequest::default()
.header(COOKIE, "cookie1=value1")
.header(COOKIE, "cookie2=value2")
.finish();
let cookies = req.cookies().unwrap();
let resp = Response::Ok()
.cookie(
2019-03-23 17:40:20 +01:00
crate::http::Cookie::build("name", "value")
.domain("www.rust-lang.org")
.path("/test")
.http_only(true)
2019-03-23 17:40:20 +01:00
.max_age(time::Duration::days(1))
.finish(),
)
.del_cookie(&cookies[1])
.finish();
let mut val: Vec<_> = resp
.headers()
.get_all(SET_COOKIE)
.map(|v| v.to_str().unwrap().to_owned())
.collect();
val.sort();
assert!(val[0].starts_with("cookie1=; Max-Age=0;"));
assert_eq!(
val[1],
"name=value; HttpOnly; Path=/test; Domain=www.rust-lang.org; Max-Age=86400"
);
}
2017-10-23 07:54:11 +02:00
2018-06-12 15:49:07 +02:00
#[test]
fn test_update_response_cookies() {
2018-10-05 20:04:59 +02:00
let mut r = Response::Ok()
2019-03-23 17:40:20 +01:00
.cookie(crate::http::Cookie::new("original", "val100"))
2018-06-12 15:49:07 +02:00
.finish();
2019-03-23 17:40:20 +01:00
r.add_cookie(&crate::http::Cookie::new("cookie2", "val200"))
2018-06-14 08:37:19 +02:00
.unwrap();
2019-03-23 17:40:20 +01:00
r.add_cookie(&crate::http::Cookie::new("cookie2", "val250"))
2018-06-14 08:37:19 +02:00
.unwrap();
2019-03-23 17:40:20 +01:00
r.add_cookie(&crate::http::Cookie::new("cookie3", "val300"))
2018-06-14 08:37:19 +02:00
.unwrap();
2018-06-12 15:49:07 +02:00
assert_eq!(r.cookies().count(), 4);
r.del_cookie("cookie2");
let mut iter = r.cookies();
let v = iter.next().unwrap();
assert_eq!((v.name(), v.value()), ("cookie3", "val300"));
let v = iter.next().unwrap();
assert_eq!((v.name(), v.value()), ("original", "val100"));
2018-06-12 15:49:07 +02:00
}
2017-11-28 23:29:22 +01:00
#[test]
fn test_basic_builder() {
let resp = Response::Ok().header("X-TEST", "value").finish();
2017-12-21 08:36:52 +01:00
assert_eq!(resp.status(), StatusCode::OK);
2017-11-28 23:29:22 +01:00
}
2017-10-23 07:54:11 +02:00
#[test]
fn test_upgrade() {
2018-11-19 23:57:12 +01:00
let resp = Response::build(StatusCode::OK)
.upgrade("websocket")
.finish();
assert!(resp.upgrade());
assert_eq!(
resp.headers().get(header::UPGRADE).unwrap(),
HeaderValue::from_static("websocket")
);
2017-10-23 07:54:11 +02:00
}
#[test]
fn test_force_close() {
2018-10-05 20:04:59 +02:00
let resp = Response::build(StatusCode::OK).force_close().finish();
2018-11-19 02:52:56 +01:00
assert!(!resp.keep_alive())
2017-10-23 07:54:11 +02:00
}
#[test]
fn test_content_type() {
2018-10-05 20:04:59 +02:00
let resp = Response::build(StatusCode::OK)
2018-04-14 01:02:01 +02:00
.content_type("text/plain")
.body(Body::Empty);
2018-05-16 01:41:46 +02:00
assert_eq!(resp.headers().get(CONTENT_TYPE).unwrap(), "text/plain")
2017-10-23 07:54:11 +02:00
}
2017-11-27 19:39:47 +01:00
#[test]
fn test_json() {
2018-10-05 20:04:59 +02:00
let resp = Response::build(StatusCode::OK).json(vec!["v1", "v2", "v3"]);
2018-03-06 04:28:42 +01:00
let ct = resp.headers().get(CONTENT_TYPE).unwrap();
2018-03-06 09:43:25 +01:00
assert_eq!(ct, HeaderValue::from_static("application/json"));
2018-11-21 16:49:24 +01:00
assert_eq!(resp.body().get_ref(), b"[\"v1\",\"v2\",\"v3\"]");
2017-11-27 19:39:47 +01:00
}
#[test]
fn test_json_ct() {
2018-10-05 20:04:59 +02:00
let resp = Response::build(StatusCode::OK)
2018-03-06 04:28:42 +01:00
.header(CONTENT_TYPE, "text/json")
.json(vec!["v1", "v2", "v3"]);
2018-03-06 04:28:42 +01:00
let ct = resp.headers().get(CONTENT_TYPE).unwrap();
2018-03-06 09:43:25 +01:00
assert_eq!(ct, HeaderValue::from_static("text/json"));
2018-11-21 16:49:24 +01:00
assert_eq!(resp.body().get_ref(), b"[\"v1\",\"v2\",\"v3\"]");
2017-11-27 19:39:47 +01:00
}
2017-11-28 22:52:53 +01:00
2018-08-08 19:58:56 +02:00
#[test]
fn test_json2() {
2018-10-05 20:04:59 +02:00
let resp = Response::build(StatusCode::OK).json2(&vec!["v1", "v2", "v3"]);
2018-08-08 19:58:56 +02:00
let ct = resp.headers().get(CONTENT_TYPE).unwrap();
assert_eq!(ct, HeaderValue::from_static("application/json"));
2018-11-21 16:49:24 +01:00
assert_eq!(resp.body().get_ref(), b"[\"v1\",\"v2\",\"v3\"]");
2018-08-08 19:58:56 +02:00
}
#[test]
fn test_json2_ct() {
2018-10-05 20:04:59 +02:00
let resp = Response::build(StatusCode::OK)
2018-08-08 19:58:56 +02:00
.header(CONTENT_TYPE, "text/json")
.json2(&vec!["v1", "v2", "v3"]);
let ct = resp.headers().get(CONTENT_TYPE).unwrap();
assert_eq!(ct, HeaderValue::from_static("text/json"));
2018-11-21 16:49:24 +01:00
assert_eq!(resp.body().get_ref(), b"[\"v1\",\"v2\",\"v3\"]");
2018-08-08 19:58:56 +02:00
}
2017-11-28 22:52:53 +01:00
#[test]
fn test_into_response() {
2018-10-05 20:04:59 +02:00
let resp: Response = "test".into();
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
2018-04-14 01:02:01 +02:00
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("text/plain; charset=utf-8")
);
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.body().get_ref(), b"test");
2017-11-28 22:52:53 +01:00
2018-10-05 20:04:59 +02:00
let resp: Response = b"test".as_ref().into();
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
2018-04-14 01:02:01 +02:00
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("application/octet-stream")
);
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.body().get_ref(), b"test");
2017-11-28 22:52:53 +01:00
2018-10-05 20:04:59 +02:00
let resp: Response = "test".to_owned().into();
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
2018-04-14 01:02:01 +02:00
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("text/plain; charset=utf-8")
);
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.body().get_ref(), b"test");
2018-04-14 01:02:01 +02:00
2018-10-05 20:04:59 +02:00
let resp: Response = (&"test".to_owned()).into();
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
2018-04-14 01:02:01 +02:00
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("text/plain; charset=utf-8")
);
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.body().get_ref(), b"test");
2018-04-14 01:02:01 +02:00
2017-11-28 22:52:53 +01:00
let b = Bytes::from_static(b"test");
2018-10-05 20:04:59 +02:00
let resp: Response = b.into();
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
2018-04-14 01:02:01 +02:00
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("application/octet-stream")
);
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.body().get_ref(), b"test");
2017-11-28 22:52:53 +01:00
let b = Bytes::from_static(b"test");
2018-10-05 20:04:59 +02:00
let resp: Response = b.into();
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
2018-04-14 01:02:01 +02:00
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("application/octet-stream")
);
2017-11-28 22:52:53 +01:00
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.body().get_ref(), b"test");
let b = BytesMut::from("test");
2018-10-05 20:04:59 +02:00
let resp: Response = b.into();
assert_eq!(resp.status(), StatusCode::OK);
2018-04-14 01:02:01 +02:00
assert_eq!(
resp.headers().get(CONTENT_TYPE).unwrap(),
HeaderValue::from_static("application/octet-stream")
);
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.body().get_ref(), b"test");
2017-11-28 22:52:53 +01:00
}
#[test]
fn test_into_builder() {
2018-10-05 20:04:59 +02:00
let mut resp: Response = "test".into();
assert_eq!(resp.status(), StatusCode::OK);
2019-03-23 17:40:20 +01:00
resp.add_cookie(&crate::http::Cookie::new("cookie1", "val100"))
2018-06-14 08:37:19 +02:00
.unwrap();
2018-06-12 15:49:07 +02:00
2019-03-10 23:30:31 +01:00
let mut builder: ResponseBuilder = resp.into();
let resp = builder.status(StatusCode::BAD_REQUEST).finish();
assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
2018-06-12 15:49:07 +02:00
let cookie = resp.cookies().next().unwrap();
assert_eq!((cookie.name(), cookie.value()), ("cookie1", "val100"));
}
2017-10-23 07:54:11 +02:00
}