1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
use http_body_util::Full;
use crate::{header, Body, BoxError, Bytes, Response, Result, StatusCode};
/// The [`Response`] Extension.
pub trait ResponseExt: private::Sealed + Sized {
/// Creates a response with an empty body.
#[must_use]
fn empty() -> Response {
Response::new(Body::empty())
}
/// Get the size of this response's body.
fn content_length(&self) -> Option<u64>;
/// Get the media type of this response.
fn content_type(&self) -> Option<mime::Mime>;
/// Get a header with the key.
fn header<K, T>(&self, key: K) -> Option<T>
where
K: header::AsHeaderName,
T: std::str::FromStr;
/// The response was successful (status in the range [`200-299`][mdn]) or not.
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/API/Response/ok>
fn ok(&self) -> bool;
/// The response with the specified [`Content-Type`][mdn].
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type>
fn with<B>(body: B, content_type: &str) -> Response
where
B: Into<Body>,
{
let mut resp = Response::new(body.into());
resp.headers_mut().insert(
header::CONTENT_TYPE,
header::HeaderValue::from_str(content_type).expect("Invalid content type"),
);
resp
}
/// The response with `text/plain; charset=utf-8` media type.
fn text<B>(body: B) -> Response
where
B: Into<Full<Bytes>>,
{
Self::with(body.into(), mime::TEXT_PLAIN_UTF_8.as_ref())
}
/// The response with `text/html; charset=utf-8` media type.
fn html<B>(body: B) -> Response
where
B: Into<Full<Bytes>>,
{
Self::with(body.into(), mime::TEXT_HTML_UTF_8.as_ref())
}
/// The response with `application/javascript; charset=utf-8` media type.
///
/// # Errors
///
/// Throws an error if serialization fails.
#[cfg(feature = "json")]
fn json<T>(body: T) -> Result<Response, crate::types::PayloadError>
where
T: serde::Serialize,
{
use bytes::{BufMut, BytesMut};
let mut buf = BytesMut::with_capacity(128).writer();
serde_json::to_writer(&mut buf, &body)
.map(|()| {
Response::with(
Full::new(buf.into_inner().freeze()),
mime::APPLICATION_JSON.as_ref(),
)
})
.map_err(crate::types::PayloadError::Json)
}
/// Responds to a stream.
fn stream<S, D, E>(stream: S) -> Response
where
S: futures_util::Stream<Item = Result<D, E>> + Send + 'static,
D: Into<Bytes> + 'static,
E: Into<BoxError> + 'static,
{
Response::new(Body::from_stream(stream))
}
/// Downloads transfers the file from path as an attachment.
#[cfg(feature = "fs")]
fn download<T>(
path: T,
name: Option<&str>,
) -> impl std::future::Future<Output = Result<Self>> + Send
where
T: AsRef<std::path::Path> + Send;
/// The [`Content-Disposition`][mdn] header indicates if the content is expected to be
/// displayed inline in the browser, that is, as a Web page or as part of a Web page,
/// or as an attachment, that is downloaded and saved locally.
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition>
fn attachment(value: &str) -> Response {
let val = header::HeaderValue::from_str(value)
.expect("content-disposition is not the correct value");
let mut resp = Response::default();
resp.headers_mut().insert(header::CONTENT_DISPOSITION, val);
resp
}
/// The [`Content-Location`][mdn] header indicates an alternate location for the returned data.
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Location>
fn location<T>(location: T) -> Response
where
T: AsRef<str>,
{
let val = header::HeaderValue::try_from(location.as_ref())
.expect("location is not the correct value");
let mut resp = Response::default();
resp.headers_mut().insert(header::CONTENT_LOCATION, val);
resp
}
/// The response redirects to the specified URL.
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/API/Response/redirect>
fn redirect<T>(url: T) -> Response
where
T: AsRef<str>,
{
let val =
header::HeaderValue::try_from(url.as_ref()).expect("url is not the correct value");
let mut resp = Response::default();
resp.headers_mut().insert(header::LOCATION, val);
resp
}
/// The response redirects to the specified URL and the status code.
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/API/Response/redirect>
fn redirect_with_status<T>(url: T, status: StatusCode) -> Response
where
T: AsRef<str>,
{
assert!(status.is_redirection(), "not a redirection status code");
let mut resp = Self::redirect(url);
*resp.status_mut() = status;
resp
}
/// The response redirects to the [`303`][mdn].
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/303>
fn see_other<T>(url: T) -> Response
where
T: AsRef<str>,
{
Self::redirect_with_status(url, StatusCode::SEE_OTHER)
}
/// The response redirects to the [`307`][mdn].
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307>
fn temporary<T>(url: T) -> Response
where
T: AsRef<str>,
{
Self::redirect_with_status(url, StatusCode::TEMPORARY_REDIRECT)
}
/// The response redirects to the [`308`][mdn].
///
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308>
fn permanent<T>(url: T) -> Response
where
T: AsRef<str>,
{
Self::redirect_with_status(url, StatusCode::PERMANENT_REDIRECT)
}
}
impl ResponseExt for Response {
fn content_length(&self) -> Option<u64> {
self.headers()
.get(header::CONTENT_LENGTH)
.map(header::HeaderValue::to_str)
.and_then(Result::ok)
.map(str::parse)
.and_then(Result::ok)
}
fn content_type(&self) -> Option<mime::Mime> {
self.header(header::CONTENT_TYPE)
}
fn header<K, T>(&self, key: K) -> Option<T>
where
K: header::AsHeaderName,
T: std::str::FromStr,
{
self.headers()
.get(key)
.map(header::HeaderValue::to_str)
.and_then(Result::ok)
.map(str::parse)
.and_then(Result::ok)
}
fn ok(&self) -> bool {
self.status().is_success()
}
#[cfg(feature = "fs")]
async fn download<T>(path: T, name: Option<&str>) -> Result<Self>
where
T: AsRef<std::path::Path> + Send,
{
let value = name
.map_or_else(
|| {
path.as_ref()
.file_name()
.and_then(std::ffi::OsStr::to_str)
.map_or("download", |filename| filename)
},
|filename| filename,
)
.escape_default();
let mut resp = Self::attachment(&format!("attachment; filename=\"{value}\""));
*resp.body_mut() = Body::from_stream(tokio_util::io::ReaderStream::new(
tokio::fs::File::open(path)
.await
.map_err(crate::Error::from)?,
));
Ok(resp)
}
}
mod private {
pub trait Sealed {}
impl Sealed for super::Response {}
}