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 567 568 569 570 571 572 573 574 575 576
//! Reply to requests.
//!
//! A [`Reply`](./trait.Reply.html) is a type that can be converted into an HTTP
//! response to be sent to the client. These are typically the successful
//! counterpart to a [rejection](../reject).
//!
//! The functions in this module are helpers for quickly creating a reply.
//! Besides them, you can return a type that implements [`Reply`](./trait.Reply.html). This
//! could be any of the following:
//!
//! - [`http::Response<impl Into<hyper::Body>>`](https://docs.rs/http)
//! - `String`
//! - `&'static str`
//! - `http::StatusCode`
//!
//! # Example
//!
//! ```
//! use warp::{Filter, http::Response};
//!
//! // Returns an empty `200 OK` response.
//! let empty_200 = warp::any().map(warp::reply);
//!
//! // Returns a `200 OK` response with custom header and body.
//! let custom = warp::any().map(|| {
//! Response::builder()
//! .header("my-custom-header", "some-value")
//! .body("and a custom body")
//! });
//!
//! // GET requests return the empty 200, POST return the custom.
//! let routes = warp::get().and(empty_200)
//! .or(warp::post().and(custom));
//! ```
use std::borrow::Cow;
use std::convert::TryFrom;
use crate::generic::{Either, One};
use http::header::{HeaderName, HeaderValue, CONTENT_TYPE};
use http::StatusCode;
use hyper::Body;
use serde::Serialize;
// This re-export just looks weird in docs...
pub(crate) use self::sealed::Reply_;
use self::sealed::{BoxedReply, Internal};
#[doc(hidden)]
pub use crate::filters::reply as with;
/// Response type into which types implementing the `Reply` trait are convertable.
pub type Response = ::http::Response<Body>;
/// Returns an empty `Reply` with status code `200 OK`.
///
/// # Example
///
/// ```
/// use warp::Filter;
///
/// // GET /just-ok returns an empty `200 OK`.
/// let route = warp::path("just-ok")
/// .map(|| {
/// println!("got a /just-ok request!");
/// warp::reply()
/// });
/// ```
#[inline]
pub fn reply() -> impl Reply {
StatusCode::OK
}
/// Convert the value into a `Reply` with the value encoded as JSON.
///
/// The passed value must implement [`Serialize`][ser]. Many
/// collections do, and custom domain types can have `Serialize` derived.
///
/// [ser]: https://serde.rs
///
/// # Example
///
/// ```
/// use warp::Filter;
///
/// // GET /ids returns a `200 OK` with a JSON array of ids:
/// // `[1, 3, 7, 13]`
/// let route = warp::path("ids")
/// .map(|| {
/// let our_ids = vec![1, 3, 7, 13];
/// warp::reply::json(&our_ids)
/// });
/// ```
///
/// # Note
///
/// If a type fails to be serialized into JSON, the error is logged at the
/// `error` level, and the returned `impl Reply` will be an empty
/// `500 Internal Server Error` response.
pub fn json<T>(val: &T) -> Json
where
T: Serialize,
{
Json {
inner: serde_json::to_vec(val).map_err(|err| {
tracing::error!("reply::json error: {}", err);
}),
}
}
/// A JSON formatted reply.
#[allow(missing_debug_implementations)]
pub struct Json {
inner: Result<Vec<u8>, ()>,
}
impl Reply for Json {
#[inline]
fn into_response(self) -> Response {
match self.inner {
Ok(body) => {
let mut res = Response::new(body.into());
res.headers_mut()
.insert(CONTENT_TYPE, HeaderValue::from_static("application/json"));
res
}
Err(()) => StatusCode::INTERNAL_SERVER_ERROR.into_response(),
}
}
}
/// Reply with a body and `content-type` set to `text/html; charset=utf-8`.
///
/// # Example
///
/// ```
/// use warp::Filter;
///
/// let body = r#"
/// <html>
/// <head>
/// <title>HTML with warp!</title>
/// </head>
/// <body>
/// <h1>warp + HTML = ♥</h1>
/// </body>
/// </html>
/// "#;
///
/// let route = warp::any()
/// .map(move || {
/// warp::reply::html(body)
/// });
/// ```
pub fn html<T>(body: T) -> Html<T>
where
Body: From<T>,
T: Send,
{
Html { body }
}
/// An HTML reply.
#[allow(missing_debug_implementations)]
pub struct Html<T> {
body: T,
}
impl<T> Reply for Html<T>
where
Body: From<T>,
T: Send,
{
#[inline]
fn into_response(self) -> Response {
let mut res = Response::new(Body::from(self.body));
res.headers_mut().insert(
CONTENT_TYPE,
HeaderValue::from_static("text/html; charset=utf-8"),
);
res
}
}
/// Types that can be converted into a `Response`.
///
/// This trait is implemented for the following:
///
/// - `http::StatusCode`
/// - `http::Response<impl Into<hyper::Body>>`
/// - `String`
/// - `&'static str`
///
/// # Example
///
/// ```rust
/// use warp::{Filter, http::Response};
///
/// struct Message {
/// msg: String
/// }
///
/// impl warp::Reply for Message {
/// fn into_response(self) -> warp::reply::Response {
/// Response::new(format!("message: {}", self.msg).into())
/// }
/// }
///
/// fn handler() -> Message {
/// Message { msg: "Hello".to_string() }
/// }
///
/// let route = warp::any().map(handler);
/// ```
pub trait Reply: BoxedReply + Send {
/// Converts the given value into a [`Response`].
///
/// [`Response`]: type.Response.html
fn into_response(self) -> Response;
/*
TODO: Currently unsure about having trait methods here, as it
requires returning an exact type, which I'd rather not commit to.
Additionally, it doesn't work great with `Box<Reply>`.
A possible alternative is to have wrappers, like
- `WithStatus<R: Reply>(StatusCode, R)`
/// Change the status code of this `Reply`.
fn with_status(self, status: StatusCode) -> Reply_
where
Self: Sized,
{
let mut res = self.into_response();
*res.status_mut() = status;
Reply_(res)
}
/// Add a header to this `Reply`.
///
/// # Example
///
/// ```rust
/// use warp::Reply;
///
/// let reply = warp::reply()
/// .with_header("x-foo", "bar");
/// ```
fn with_header<K, V>(self, name: K, value: V) -> Reply_
where
Self: Sized,
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
{
match <HeaderName as TryFrom<K>>::try_from(name) {
Ok(name) => match <HeaderValue as TryFrom<V>>::try_from(value) {
Ok(value) => {
let mut res = self.into_response();
res.headers_mut().append(name, value);
Reply_(res)
},
Err(err) => {
tracing::error!("with_header value error: {}", err.into());
Reply_(::reject::server_error()
.into_response())
}
},
Err(err) => {
tracing::error!("with_header name error: {}", err.into());
Reply_(::reject::server_error()
.into_response())
}
}
}
*/
}
impl<T: Reply + ?Sized> Reply for Box<T> {
fn into_response(self) -> Response {
self.boxed_into_response(Internal)
}
}
fn _assert_object_safe() {
fn _assert(_: &dyn Reply) {}
}
/// Wrap an `impl Reply` to change its `StatusCode`.
///
/// # Example
///
/// ```
/// use warp::Filter;
///
/// let route = warp::any()
/// .map(warp::reply)
/// .map(|reply| {
/// warp::reply::with_status(reply, warp::http::StatusCode::CREATED)
/// });
/// ```
pub fn with_status<T: Reply>(reply: T, status: StatusCode) -> WithStatus<T> {
WithStatus { reply, status }
}
/// Wrap an `impl Reply` to change its `StatusCode`.
///
/// Returned by `warp::reply::with_status`.
#[derive(Debug)]
pub struct WithStatus<T> {
reply: T,
status: StatusCode,
}
impl<T: Reply> Reply for WithStatus<T> {
fn into_response(self) -> Response {
let mut res = self.reply.into_response();
*res.status_mut() = self.status;
res
}
}
/// Wrap an `impl Reply` to add a header when rendering.
///
/// # Example
///
/// ```
/// use warp::Filter;
///
/// let route = warp::any()
/// .map(warp::reply)
/// .map(|reply| {
/// warp::reply::with_header(reply, "server", "warp")
/// });
/// ```
pub fn with_header<T: Reply, K, V>(reply: T, name: K, value: V) -> WithHeader<T>
where
HeaderName: TryFrom<K>,
<HeaderName as TryFrom<K>>::Error: Into<http::Error>,
HeaderValue: TryFrom<V>,
<HeaderValue as TryFrom<V>>::Error: Into<http::Error>,
{
let header = match <HeaderName as TryFrom<K>>::try_from(name) {
Ok(name) => match <HeaderValue as TryFrom<V>>::try_from(value) {
Ok(value) => Some((name, value)),
Err(err) => {
let err = err.into();
tracing::error!("with_header value error: {}", err);
None
}
},
Err(err) => {
let err = err.into();
tracing::error!("with_header name error: {}", err);
None
}
};
WithHeader { header, reply }
}
/// Wraps an `impl Reply` and adds a header when rendering.
///
/// Returned by `warp::reply::with_header`.
#[derive(Debug)]
pub struct WithHeader<T> {
header: Option<(HeaderName, HeaderValue)>,
reply: T,
}
impl<T: Reply> Reply for WithHeader<T> {
fn into_response(self) -> Response {
let mut res = self.reply.into_response();
if let Some((name, value)) = self.header {
res.headers_mut().insert(name, value);
}
res
}
}
impl<T: Send> Reply for ::http::Response<T>
where
Body: From<T>,
{
#[inline]
fn into_response(self) -> Response {
self.map(Body::from)
}
}
impl Reply for ::http::StatusCode {
#[inline]
fn into_response(self) -> Response {
let mut res = Response::default();
*res.status_mut() = self;
res
}
}
impl Reply for ::http::Error {
#[inline]
fn into_response(self) -> Response {
tracing::error!("reply error: {:?}", self);
StatusCode::INTERNAL_SERVER_ERROR.into_response()
}
}
impl<T, E> Reply for Result<T, E>
where
T: Reply,
E: Reply,
{
#[inline]
fn into_response(self) -> Response {
match self {
Ok(t) => t.into_response(),
Err(e) => e.into_response(),
}
}
}
fn text_plain<T: Into<Body>>(body: T) -> Response {
let mut response = ::http::Response::new(body.into());
response.headers_mut().insert(
CONTENT_TYPE,
HeaderValue::from_static("text/plain; charset=utf-8"),
);
response
}
impl Reply for String {
#[inline]
fn into_response(self) -> Response {
text_plain(self)
}
}
impl Reply for Vec<u8> {
#[inline]
fn into_response(self) -> Response {
::http::Response::builder()
.header(
CONTENT_TYPE,
HeaderValue::from_static("application/octet-stream"),
)
.body(Body::from(self))
.unwrap()
}
}
impl Reply for &'static str {
#[inline]
fn into_response(self) -> Response {
text_plain(self)
}
}
impl Reply for Cow<'static, str> {
#[inline]
fn into_response(self) -> Response {
match self {
Cow::Borrowed(s) => s.into_response(),
Cow::Owned(s) => s.into_response(),
}
}
}
impl Reply for &'static [u8] {
#[inline]
fn into_response(self) -> Response {
::http::Response::builder()
.header(
CONTENT_TYPE,
HeaderValue::from_static("application/octet-stream"),
)
.body(Body::from(self))
.unwrap()
}
}
impl<T, U> Reply for Either<T, U>
where
T: Reply,
U: Reply,
{
#[inline]
fn into_response(self) -> Response {
match self {
Either::A(a) => a.into_response(),
Either::B(b) => b.into_response(),
}
}
}
impl<T> Reply for One<T>
where
T: Reply,
{
#[inline]
fn into_response(self) -> Response {
self.0.into_response()
}
}
impl Reply for std::convert::Infallible {
#[inline(always)]
fn into_response(self) -> Response {
match self {}
}
}
mod sealed {
use super::{Reply, Response};
// An opaque type to return `impl Reply` from trait methods.
#[allow(missing_debug_implementations)]
pub struct Reply_(pub(crate) Response);
impl Reply for Reply_ {
#[inline]
fn into_response(self) -> Response {
self.0
}
}
#[allow(missing_debug_implementations)]
pub struct Internal;
// Implemented for all types that implement `Reply`.
//
// A user doesn't need to worry about this, it's just trait
// hackery to get `Box<dyn Reply>` working.
pub trait BoxedReply {
fn boxed_into_response(self: Box<Self>, internal: Internal) -> Response;
}
impl<T: Reply> BoxedReply for T {
fn boxed_into_response(self: Box<Self>, _: Internal) -> Response {
(*self).into_response()
}
}
}
#[cfg(test)]
mod tests {
use std::collections::HashMap;
use super::*;
#[test]
fn json_serde_error() {
// a HashMap<Vec, _> cannot be serialized to JSON
let mut map = HashMap::new();
map.insert(vec![1, 2], 45);
let res = json(&map).into_response();
assert_eq!(res.status(), 500);
}
#[test]
fn response_builder_error() {
let res = ::http::Response::builder()
.status(1337)
.body("woops")
.into_response();
assert_eq!(res.status(), 500);
}
#[test]
fn boxed_reply() {
let r: Box<dyn Reply> = Box::new(reply());
let resp = r.into_response();
assert_eq!(resp.status(), 200);
}
}