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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
use std::convert::TryFrom;
#[derive(Debug)]
#[must_use]
/// An HTTP response.
///
/// An HTTP Response consists of a head (a status code and some headers), and
/// a body (which may be empty). This type offers convenient helpers for
/// constructing HTTP responses for you for common use-cases.
///
/// # Examples
///
/// ```rust
/// use under::{Request, Response, HttpEntity};
///
/// // Here, we're defining an endpoint for our server.
/// async fn handle_get(request: Request) -> Result<Response, anyhow::Error> {
/// let target = request.fragment_str("target").unwrap_or("world");
/// Ok(Response::text(format!("hello, {}", target)))
/// }
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), anyhow::Error> {
/// let mut http = under::http();
/// http
/// .at("/hello").get(handle_get)
/// .at("/hello/{target}").get(handle_get);
/// http.prepare();
/// let mut response = http.handle(Request::get("/hello")?).await?;
/// assert_eq!(response.status(), http::StatusCode::OK);
/// let body = response.data(512).into_text().await?;
/// assert_eq!(body, "hello, world");
/// # Ok(())
/// # }
/// ```
pub struct Response(http::Response<hyper::Body>);
macro_rules! forward {
() => {};
(
$(#[$m:meta])* $v:vis fn $name:ident(&self $(, $pn:ident: $pt:ty)*) -> $ret:ty;
$($tail:tt)*
) => {
$(#[$m])* $v fn $name(&self $(, $pn: $pt)*) -> $ret {
(self.0).$name($($pn),*)
}
forward! { $($tail)* }
};
(
$(#[$m:meta])* $v:vis fn $name:ident(&mut self $(, $pn:ident: $pt:ty)*) -> $ret:ty;
$($tail:tt)*
) => {
$(#[$m])* $v fn $name(&mut self $(, $pn: $pt)*) -> $ret {
(self.0).$name($($pn),*)
}
forward! { $($tail)* }
}
}
impl Response {
/// Creates an empty response with a status code of 200.
///
/// See [`Response::empty_status`] for more information.
///
/// # Example
/// ```rust
/// # use under::*;
/// let response = Response::empty_200();
/// assert_eq!(response.status(), http::StatusCode::OK);
/// ```
pub fn empty_200() -> Self {
Self::empty_status(http::StatusCode::OK)
}
/// Creates an empty response with a status code of 204.
///
/// See [`Response::empty_status`] for more information.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::empty_204();
/// assert_eq!(response.status(), http::StatusCode::NO_CONTENT);
/// ```
pub fn empty_204() -> Self {
Response::empty_status(http::StatusCode::NO_CONTENT)
}
/// Creates an empty response with a status code of 404.
///
/// See [`Response::empty_status`] for more information.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::empty_404();
/// assert_eq!(response.status(), http::StatusCode::NOT_FOUND);
/// ```
pub fn empty_404() -> Self {
Response::empty_status(http::StatusCode::NOT_FOUND)
}
/// Creates an empty response with a status code of 500.
///
/// See [`Response::empty_status`] for more information.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::empty_500();
/// assert_eq!(response.status(), http::StatusCode::INTERNAL_SERVER_ERROR);
/// ```
pub fn empty_500() -> Self {
Response::empty_status(http::StatusCode::INTERNAL_SERVER_ERROR)
}
/// Creates a redirect (using See Other) to the given location.
///
/// # Errors
/// This attempts to convert the location into a [`http::HeaderValue`];
/// however, the conversion may fail (for reasons specified on
/// [`http::HeaderValue::from_str`]). It may also fail to construct the
/// underlying response.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::see_other("/foo").unwrap();
/// assert_eq!(response.status(), http::StatusCode::SEE_OTHER);
/// ```
pub fn see_other<T>(location: T) -> Result<Self, http::Error>
where
http::HeaderValue: TryFrom<T>,
<http::HeaderValue as TryFrom<T>>::Error: Into<http::Error>,
{
Ok(Response(
http::Response::builder()
.status(http::StatusCode::SEE_OTHER)
.header(http::header::LOCATION, location)
.body(hyper::Body::empty())?,
))
}
/// Creates a permanent redirect to the given location.
///
/// # Errors
/// This attempts to convert the location into a
/// [`http::HeaderValue`]; however, the conversion may fail (for
/// reasons specified on [`http::HeaderValue::from_str`]). It may also
/// fail to construct the underlying response.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::permanent_redirect("/foo").unwrap();
/// assert_eq!(response.status(), http::StatusCode::PERMANENT_REDIRECT);
/// ```
pub fn permanent_redirect<T>(location: T) -> Result<Self, http::Error>
where
http::HeaderValue: TryFrom<T>,
<http::HeaderValue as TryFrom<T>>::Error: Into<http::Error>,
{
Ok(Response(
http::Response::builder()
.status(http::StatusCode::PERMANENT_REDIRECT)
.header(http::header::LOCATION, location)
.body(hyper::Body::empty())?,
))
}
/// Creates a temporary redirect to the given location.
///
/// # Errors
/// This attempts to convert the location into a
/// [`http::HeaderValue`]; however, the conversion may fail (for
/// reasons specified on [`http::HeaderValue::from_str`]). It may also
/// fail to construct the underlying response.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::temporary_redirect("/foo").unwrap();
/// assert_eq!(response.status(), http::StatusCode::TEMPORARY_REDIRECT);
/// ```
pub fn temporary_redirect<T>(location: T) -> Result<Self, http::Error>
where
http::HeaderValue: TryFrom<T>,
<http::HeaderValue as TryFrom<T>>::Error: Into<http::Error>,
{
Ok(Response(
http::Response::builder()
.status(http::StatusCode::TEMPORARY_REDIRECT)
.header(http::header::LOCATION, location)
.body(hyper::Body::empty())?,
))
}
/// Creates a response with an empty body and a set status. The
/// Content-Type is not set.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::empty_status(http::StatusCode::NOT_FOUND);
/// assert_eq!(response.status(), http::StatusCode::NOT_FOUND);
/// ```
#[allow(clippy::missing_panics_doc)]
pub fn empty_status(status: http::StatusCode) -> Self {
// This shouldn't panic, as the headers are garenteed to be valid.
Response(
http::Response::builder()
.status(status)
.body(hyper::Body::empty())
.unwrap(),
)
}
/// Creates a response with the given text body. The returned response
/// has a `Content-Type` of `text/plain; charset=utf-8`.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::text("hello, world");
/// ```
#[allow(clippy::missing_panics_doc)]
pub fn text<V: Into<String>>(body: V) -> Self {
// This shouldn't panic, as the headers are garenteed to be valid.
Response(
http::Response::builder()
.header(http::header::CONTENT_TYPE, "text/plain; charset=utf-8")
.body(body.into().into())
.unwrap(),
)
}
/// Creates a response with the given JSON body. The returned response
/// has a `Content-Type` of `application/json; charset=utf-8`.
///
/// # Errors
/// This errors if the underlying JSON serialization fails; and it will
/// return that exact error.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::json(&serde_json::json!({ "hello": "world" }))?;
/// # Ok::<(), anyhow::Error>(())
/// ```
#[cfg(feature = "json")]
#[allow(clippy::missing_panics_doc)]
pub fn json<V: serde::Serialize>(body: &V) -> Result<Self, serde_json::Error> {
let value = serde_json::to_string(body)?;
// This shouldn't panic, as the value is a valid JSON string, and the
// headers are garenteed to be valid.
Ok(Response(
http::Response::builder()
.header(
http::header::CONTENT_TYPE,
"application/json; charset=utf-8",
)
.body(value.into())
.unwrap(),
))
}
/// Sets the current responses's status code.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut response = Response::empty_404();
/// response.set_status(http::StatusCode::OK);
/// assert_eq!(response.status(), http::StatusCode::OK);
/// ```
pub fn set_status<S: Into<http::StatusCode>>(&mut self, status: S) {
*self.0.status_mut() = status.into();
}
/// Returns a response with the new status code.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::empty_404();
/// let response = response.with_status(http::StatusCode::OK);
/// assert_eq!(response.status(), http::StatusCode::OK);
/// ```
pub fn with_status<S: Into<http::StatusCode>>(mut self, status: S) -> Self {
*self.0.status_mut() = status.into();
Response(self.0)
}
/// Returns state information provided by the
/// [`crate::middleware::StateMiddleware`] middleware. This is a
/// shortcut to retrieving the [`crate::middleware::State`]
/// extension from the response.
///
/// # Examples
/// ```rust
/// # use under::*;
/// use under::middleware::State;
/// let mut response = Response::empty_200();
/// response.extensions_mut().insert(State(123u32));
/// assert_eq!(response.state::<u32>(), Some(&123u32));
/// ```
pub fn state<T: Send + Sync + 'static>(&self) -> Option<&T> {
self.ext::<crate::middleware::State<T>>().map(|v| &v.0)
}
/// Retrieves a specific extension from the extensions map. This is
/// the same as calling [`Self::extensions`].`get` wit the given
/// type parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut response = Response::empty_200();
/// assert_eq!(response.ext::<u32>(), None);
/// ```
pub fn ext<T: Send + Sync + 'static>(&self) -> Option<&T> {
self.extensions().get::<T>()
}
/// Retrieves a mutable reference to the specific extension from the
/// extensions map. This is the same as calling
/// [`Self::extensions_mut`].`get_mut` with the given type
/// parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut response = Response::empty_200();
/// assert_eq!(response.ext_mut::<u32>(), None);
/// ```
pub fn ext_mut<T: Send + Sync + 'static>(&mut self) -> Option<&mut T> {
self.extensions_mut().get_mut::<T>()
}
/// Sets the value of the specific extension in the extensions map.
/// This is the same as calling [`Self::extensions_mut`].`insert`
/// with the given parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut response = Response::empty_200();
/// response.set_ext(123u32);
/// assert_eq!(response.ext::<u32>(), Some(&123u32));
/// ```
pub fn set_ext<T: Send + Sync + 'static>(&mut self, value: T) -> &mut Self {
self.extensions_mut().insert(value);
self
}
/// Sets the value of the specific extension in the extensions map,
/// consuming `self`, and then returning the new value. This is
/// the same as calling [`Self::set_ext`], but it consumes `self`.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::empty_200();
/// let response = response.with_ext(123u32);
/// assert_eq!(response.ext::<u32>(), Some(&123u32));
/// ```
pub fn with_ext<T: Send + Sync + 'static>(mut self, value: T) -> Self {
self.set_ext(value);
self
}
/// Removes the specific extension from the extensions map. This is
/// the same as calling [`Self::extensions_mut`].`remove` with the
/// given type parameter.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let mut response = Response::empty_200()
/// .with_ext(123u32);
/// assert_eq!(response.ext::<u32>(), Some(&123u32));
/// response.remove_ext::<u32>();
/// assert_eq!(response.ext::<u32>(), None);
/// ```
pub fn remove_ext<T: Send + Sync + 'static>(&mut self) -> Option<T> {
self.extensions_mut().remove::<T>()
}
/// Removes the specific extension from the extensions map,
/// consuming `self`, and then returning the removed value. This
/// is the same as calling [`Self::remove_ext`], but it consumes
/// `self`.
///
/// # Examples
/// ```rust
/// # use under::*;
/// let response = Response::empty_200()
/// .with_ext(123u32);
/// assert_eq!(response.ext::<u32>(), Some(&123u32));
/// let response = response.without_ext::<u32>();
/// assert_eq!(response.ext::<u32>(), None);
/// ```
pub fn without_ext<T: Send + Sync + 'static>(mut self) -> Self {
self.remove_ext::<T>();
self
}
forward! {
/// Returns the [`http::StatusCode`].
///
/// # Examples
///
/// ```rust
/// # use under::*;
/// let response = Response::default();
/// assert_eq!(response.status(), http::StatusCode::OK);
/// ```
pub fn status(&self) -> http::StatusCode;
/// Returns a reference to the associated extensions.
///
/// # Examples
///
/// ```rust
/// # use under::*;
/// let response = Response::default();
/// assert!(response.extensions().get::<i32>().is_none());
/// ```
pub fn extensions(&self) -> &http::Extensions;
/// Returns a mutable reference to the associated extensions.
///
/// # Examples
///
/// ```rust
/// # use under::*;
/// let mut response = Response::default();
/// response.extensions_mut().insert("hello");
/// assert_eq!(response.extensions().get(), Some(&"hello"));
/// ```
pub fn extensions_mut(&mut self) -> &mut http::Extensions;
/// Returns a reference to the associated header field map.
///
/// # Examples
///
/// ```rust
/// # use under::*;
/// let response = Response::default();
/// assert!(response.headers().is_empty());
/// ```
pub fn headers(&self) -> &http::HeaderMap<http::HeaderValue>;
/// Returns a mutable reference to the associated header field map.
///
/// # Examples
///
/// ```
/// # use under::*;
/// # use http::header::*;
/// let mut response = Response::default();
/// response.headers_mut().insert(HOST, HeaderValue::from_static("world"));
/// assert!(!response.headers().is_empty());
/// ```
pub fn headers_mut(&mut self) -> &mut http::HeaderMap<http::HeaderValue>;
}
}
impl crate::HttpEntity for Response {
#[inline]
fn body_mut(&mut self) -> &mut hyper::Body {
self.0.body_mut()
}
#[inline]
fn headers(&self) -> &http::HeaderMap<http::HeaderValue> {
self.0.headers()
}
#[inline]
fn headers_mut(&mut self) -> &mut http::HeaderMap<http::HeaderValue> {
self.0.headers_mut()
}
}
impl Default for Response {
fn default() -> Self {
Response(
http::Response::builder()
.body(hyper::Body::empty())
.unwrap(),
)
}
}
impl From<http::Response<hyper::Body>> for Response {
fn from(hy: http::Response<hyper::Body>) -> Self {
Response(hy)
}
}
impl From<Response> for http::Response<hyper::Body> {
fn from(this: Response) -> Self {
this.0
}
}
/// Converts the current type into a [`crate::Response`].
///
/// This assumes that the conversion into a response is fallible
/// (as it often is). This is used instead of `TryFrom` because
/// `TryFrom<Result<T, E>>` is not implemented for `Result<T, E>`.
///
/// This uses `anyhow::Error` as the error type for a few reasons:
///
/// 1. [`anyhow::Error`] does not implement [`std::error::Error`].
/// 2. [`std::convert::Infallible`]/[`!`] does not implement
/// `Into<T>`/`From<T>`.
/// 3. I can't figure out how to reconcile the two such that
/// `IntoResponse` can be implemented for `Result<R, E>` where
/// `R: IntoResponse`; especially if `R` is `Response`, as the
/// `IntoResponse` implementation for that would have the error
/// type be `Infallible`.
pub trait IntoResponse {
/// Converts the current type into a response.
///
/// # Errors
/// This can error if the conversion into a response fails.
/// This can fail if the current type is a `Result`, or if
/// e.g. the response fails to serialize.
fn into_response(self) -> Result<Response, anyhow::Error>;
}
impl IntoResponse for Response {
fn into_response(self) -> Result<Response, anyhow::Error> {
Ok(self)
}
}
impl<R, E> IntoResponse for Result<R, E>
where
R: IntoResponse,
E: Into<anyhow::Error>,
{
fn into_response(self) -> Result<Response, anyhow::Error> {
self.map_err(Into::into)
.and_then(|r| r.into_response().map_err(Into::into))
}
}
impl IntoResponse for std::convert::Infallible {
fn into_response(self) -> Result<Response, anyhow::Error> {
match self {}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn convert_response() {
let response = Response::empty_500();
assert!(Ok::<_, std::convert::Infallible>(response)
.into_response()
.is_ok());
}
}