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
use crate::state::State;
use crate::{App, Error, Result};
use cookie::{Cookie, CookieJar};
use headers::{Header, HeaderMapExt};
use hyper::header::HeaderValue;
use hyper::{body::Buf, Body, HeaderMap, StatusCode};
use route_recognizer::Params;
use serde::de::DeserializeOwned;
use std::io::Read;
use std::net::SocketAddr;
use std::sync::Arc;
use tracing::error;
/// An incoming request
pub struct Request<S: State> {
app: Arc<App<S>>,
context: S::Context,
params: Params,
inner: hyper::Request<Body>,
remote_addr: SocketAddr,
}
impl<S: State> Request<S> {
pub(crate) fn new(
app: Arc<App<S>>,
inner: hyper::Request<Body>,
params: Params,
remote_addr: SocketAddr,
context: S::Context,
) -> Self {
Self {
app,
context,
inner,
params,
remote_addr,
}
}
pub(crate) fn into_parts(self) -> (hyper::Request<Body>, Params, SocketAddr, S::Context) {
(self.inner, self.params, self.remote_addr, self.context)
}
pub(crate) fn merge_params(&mut self, params: Params) {
for (k, v) in params.iter() {
self.params.insert(k.to_owned(), v.to_owned());
}
}
/// Get a reference to the App's state
pub fn state(&self) -> &S {
self.app.state()
}
/// Get a reference to the request's context
pub fn context(&self) -> &S::Context {
&self.context
}
/// Get a mut reference to the request's context
pub fn context_mut(&mut self) -> &mut S::Context {
&mut self.context
}
/// Get the HTTP method being used by this request
pub fn method(&self) -> &hyper::Method {
self.inner.method()
}
/// Get the URI that was used for this request
pub fn uri(&self) -> &hyper::Uri {
self.inner.uri()
}
/// Parse the URI query string into an instance of `T` that derives `Deserialize`.
///
/// (To get the raw query string access it via `req.uri().query()`).
/// If there is no query string, deserialize an empty string.
pub fn query<T: DeserializeOwned>(&self) -> Result<T> {
// if there is no query string we can default to empty string
// serde_urlencode will work if T has all optional fields
let q = self.inner.uri().query().unwrap_or("");
let t = serde_urlencoded::from_str::<T>(q)
.map_err(|err| Error::bad_request(format!("invalid query parameter: {}", err)))?;
Ok(t)
}
/// Get a typed header from the request
/// (See also `headers`)
pub fn header<T: Header>(&self) -> Option<T> {
self.inner.headers().typed_get()
}
/// Get all headers as a `HeaderMap`
pub fn headers(&self) -> &HeaderMap<HeaderValue> {
self.inner.headers()
}
/// Get the request's cookies
pub fn cookies(&self) -> Result<CookieJar> {
let mut cookies = CookieJar::new();
for val in self.inner.headers().get_all(headers::Cookie::name()) {
let c = Cookie::parse(val.to_str()?)?;
cookies.add(c.into_owned());
}
Ok(cookies)
}
/// Get a route parameter (eg. `:key` or `*key` segments in the URI path)
///
/// If the parameter is not present, logs an error and returns a `400 Bad Request` to the client
pub fn param(&self, param: &str) -> Result<&str> {
self.params.find(param).ok_or_else(|| {
error!("parameter {} not found", param);
Error::http(StatusCode::BAD_REQUEST)
})
}
/// Get all route parameters
pub fn params(&self) -> &Params {
&self.params
}
/// Get the request body as a `hyper::Body`
pub async fn body_mut(&mut self) -> Result<&mut Body> {
Ok(self.inner.body_mut())
}
pub(crate) fn as_inner_mut(&mut self) -> &mut hyper::Request<Body> {
&mut self.inner
}
/// Get a reader to read the request body
///
/// (This does buffer the whole body into memory, but not necessarily contiguous memory).
/// If you need to protect against malicious clients you should access the body via `body_mut`
pub async fn reader(&mut self) -> Result<impl Read + '_> {
let buffer = hyper::body::aggregate(self.inner.body_mut()).await?;
Ok(buffer.reader())
}
/// Get the request body as raw bytes in a `Vec<u8>`
pub async fn body_bytes(&mut self) -> Result<Vec<u8>> {
let bytes = hyper::body::to_bytes(self.inner.body_mut()).await?;
Ok(bytes.to_vec())
}
/// Get the request body as UTF-8 data in String
pub async fn body_string(&mut self) -> Result<String> {
let bytes = hyper::body::to_bytes(self.inner.body_mut()).await?;
Ok(String::from_utf8(bytes.to_vec())?)
}
/// Get the request body as JSON and deserialize into `T`.
///
/// If deserialization fails, log an error and return `400 Bad Request`.
/// (If this logic is not appropriate, consider using `reader` and using `serde_json` directly)
pub async fn body_json<T: DeserializeOwned>(&mut self) -> Result<T> {
let reader = self.reader().await?;
serde_json::from_reader(reader).map_err(|err| {
let msg = format!("error parsing request body as json: {}", err);
error!("{}", msg);
Error::http((StatusCode::BAD_REQUEST, msg))
})
}
/// Get the address of the remote peer.
///
/// This method uses the network level address only and hence may be incorrect if you are
/// behind a proxy. (This does *not* check for any `Forwarded` headers etc...)
pub fn remote_addr(&self) -> &SocketAddr {
&self.remote_addr
}
}