arc-reactor 0.2.4

Minimal, Asynchronous, Web Framework
Documentation 
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 core::file;
use futures::prelude::*;
use http::response::Parts;
use hyper::{
	self,
	header::{HeaderMap, HeaderValue, CONTENT_LENGTH, CONTENT_TYPE, LOCATION},
	Body,
	StatusCode,
	Version,
};
use mime_guess::guess_mime_type;
use std::{fmt::Debug, path::Path};
use tokio::{fs::File, io::ErrorKind};

#[derive(Debug)]
pub struct Response {
	pub(crate) parts: Parts,
	pub(crate) body: Body,
}

impl Response {
	pub fn new() -> Self {
		Response::default()
	}

	/// Get the HTTP version of this response.
	#[inline]
	pub fn version(&self) -> Version {
		self.parts.version
	}

	/// Get the headers from the response.
	#[inline]
	pub fn headers(&self) -> &HeaderMap<HeaderValue> {
		&self.parts.headers
	}

	/// Get a mutable reference to the headers.
	#[inline]
	pub fn headers_mut(&mut self) -> &mut HeaderMap<HeaderValue> {
		&mut self.parts.headers
	}

	/// Get the status from the server.
	#[inline]
	pub fn status(&self) -> StatusCode {
		self.parts.status
	}

	pub fn status_mut(&mut self) -> &mut StatusCode {
		&mut self.parts.status
	}

	/// Set the `StatusCode` for this response.
	///
	/// # Example
	///
	/// ```rust, ignore
	/// pub fn get_profile(req: Request, res: Response) {
	/// 	// performed task on request
	///
	/// 	// return an 401 response
	/// 	res.set_status(401);
	/// }
	/// ```
	///
	#[inline]
	pub fn set_status(&mut self, status: u16) {
		self.parts.status = StatusCode::from_u16(status).unwrap();
	}

	/// Set the status and move the Response.
	///
	/// Useful for the "builder-style" pattern.
	#[inline]
	pub fn with_status(mut self, status: u16) -> Self {
		self.parts.status = StatusCode::from_u16(status).unwrap();
		self
	}

	/// Set a text/plain response.
	#[inline]
	pub fn text<T: Into<String>>(&mut self, body: T) {
		let body = body.into();
		self.headers_mut().insert(
			CONTENT_LENGTH,
			HeaderValue::from_str(&body.len().to_string()).unwrap(),
		);
		self.body = Body::from(body);
	}

	/// set a text/plain response
	/// moves the response
	///
	/// useful for builder-style
	#[inline]
	pub fn with_text<T: Into<String>>(mut self, body: T) -> Self {
		self.text(body);

		self
	}

	/// get a reference to a type previously set on the response
	pub fn get<T: Send + Sync + 'static>(&self) -> Option<&T> {
		self.parts.extensions.get::<T>()
	}

	/// Set a type on the response.
	pub fn set<T: Send + Sync + 'static>(&mut self, value: T) -> Option<T> {
		self.parts.extensions.insert::<T>(value)
	}

	/// Removes the type previously set on the response.
	pub fn remove<T: Send + Sync + 'static>(&mut self) -> Option<T> {
		self.parts.extensions.remove::<T>()
	}

	/// Respond with a file.
	/// this method will set the appropriate Content-type and Content-Length
	/// headers unfortunately, this doesn't support byte ranges, yet.
	/// The file is streamed asynchronously from the filesystem to the client
	/// with the Content-Encoding: chunked.
	pub fn with_file<P>(mut self, pathbuf: P) -> impl Future<Item = Response, Error = Response>
	where
		P: AsRef<Path> + Send + Clone + Debug + 'static,
	{
		let path_clone = pathbuf.clone();

		File::open(pathbuf)
			.and_then(file::metadata)
			.then(move |result| {
				match result {
					Ok((file, meta)) => {
						let mime_type = guess_mime_type(path_clone.clone());
						self.headers_mut().insert(
							CONTENT_LENGTH,
							HeaderValue::from_str(&meta.len().to_string()).unwrap(),
						);
						self.headers_mut().insert(
							CONTENT_TYPE,
							HeaderValue::from_str(mime_type.as_ref()).unwrap(),
						);

						self.body = Body::wrap_stream(file::stream(file));

						Ok(self)
					}
					Err(err) => {
						error!("Error responding with a file: {}", err);
						match err.kind() {
							ErrorKind::NotFound => self.set_status(404),
							_ => self.set_status(500),
						};
						Err(self)
					}
				}
			})
	}

	/// Set the body and move the Response.
	///
	/// Useful for the "builder-style" pattern.
	#[inline]
	pub fn with_body<T: Into<Body>>(mut self, body: T) -> Self {
		self.body = body.into();
		self
	}

	#[inline]
	pub fn set_body<T: Into<Body>>(&mut self, body: T) {
		self.body = body.into();
	}

	/// Read the body.
	#[inline]
	pub fn body_ref(&self) -> &Body {
		&self.body
	}

	/// Take the `Body` of this response.
	#[inline]
	pub fn body(self) -> Body {
		self.body
	}

	/// Set a HTTP redirect on the response header
	pub fn redirect(mut self, url: &'static str) -> Response {
		self.set_status(301);
		self.headers_mut()
			.insert(LOCATION, HeaderValue::from_static(url));

		self
	}

	/// Set the status code 401 on the response
	pub fn unauthorized(self) -> Self {
		self.with_status(401)
	}

	/// Set the status code 400 on the response
	pub fn badRequest(self) -> Self {
		self.with_status(400)
	}

	/// Set the status code 403 on the response
	pub fn forbidden(self) -> Self {
		self.with_status(403)
	}

	/// Set the status code 405 on the response
	pub fn methodNotAllowed(self) -> Self {
		self.with_status(405)
	}

	/// Set the status code 406 on the response
	pub fn notAcceptable(self) -> Self {
		self.with_status(406)
	}

	/// Set the status code 408 on the response
	pub fn requestTimeout(self) -> Self {
		self.with_status(408)
	}

	/// Set the status code 500 on the response
	pub fn internalServerError(self) -> Self {
		self.with_status(500)
	}

	/// Set the status code 502 on the response
	pub fn badGateway(self) -> Self {
		self.with_status(502)
	}

	/// Set the status code 503 on the response
	pub fn serviceUnavailable(self) -> Self {
		self.with_status(503)
	}
}

impl Default for Response {
	fn default() -> Response {
		let (parts, body) = hyper::Response::new(Body::empty()).into_parts();
		Response { parts, body }
	}
}

pub fn res() -> Response {
	Response::default()
}