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
//! 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::get2().and(empty_200) //! .or(warp::post2().and(custom)); //! ``` use http::header::{CONTENT_TYPE, HeaderValue}; use http::StatusCode; use serde::Serialize; use serde_json; use ::reject::Reject; // This re-export just looks weird in docs... #[doc(hidden)] pub use ::filters::reply as with; pub(crate) use self::sealed::{Reply_, ReplySealed, Response}; /// 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 /// `warn` level, and the returned `impl Reply` will be an empty /// `500 Internal Server Error` response. pub fn json<T>(val: &T) -> impl Reply where T: Serialize, { Json { inner: serde_json::to_vec(val).map_err(|err| { warn!("reply::json error: {}", err); }), } } #[allow(missing_debug_implementations)] struct Json { inner: Result<Vec<u8>, ()>, } impl ReplySealed 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(()) => { ::reject::server_error() .into_response() } } } } /// Types that can be converted into a `Response`. /// /// This trait is sealed for now (implementations are only allowed inside /// warp), but it is implemented for the following: /// /// - `http::StatusCode` /// - `http::Response<impl Into<hyper::Body>>` /// - `String` /// - `&'static str` //NOTE: This list is duplicated in the module documentation. pub trait Reply: ReplySealed { /* 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: HttpTryFrom<K>, HeaderValue: HttpTryFrom<V>, { match <HeaderName as HttpTryFrom<K>>::try_from(name) { Ok(name) => match <HeaderValue as HttpTryFrom<V>>::try_from(value) { Ok(value) => { let mut res = self.into_response(); res.headers_mut().append(name, value); Reply_(res) }, Err(err) => { warn!("with_header value error: {}", err.into()); Reply_(::reject::server_error() .into_response()) } }, Err(err) => { warn!("with_header name error: {}", err.into()); Reply_(::reject::server_error() .into_response()) } } } */ } impl<T: ReplySealed> Reply for T {} fn _assert_object_safe() { fn _assert(_: &Reply) {} } // Seal the `Reply` trait and the `Reply_` wrapper type for now. mod sealed { use hyper::Body; use ::generic::{Either, One}; use ::reject::Reject; use super::Reply; pub type Response = ::http::Response<Body>; // A trait describing the various things that a Warp server can turn into a `Response`. pub trait ReplySealed: Send { fn into_response(self) -> Response; } /// ```compile_fail /// use warp::Reply; /// /// let _ = warp::reply().into_response(); /// ``` pub fn __warp_replysealed_compilefail_doctest() { // Duplicate code to make sure the code is otherwise valid. let _ = ::reply().into_response(); } // An opaque type to return `impl Reply` from trait methods. #[allow(missing_debug_implementations)] pub struct Reply_(pub(crate) Response); impl ReplySealed for Reply_ { #[inline] fn into_response(self) -> Response { self.0 } } impl<T: Send> ReplySealed for ::http::Response<T> where Body: From<T>, { #[inline] fn into_response(self) -> Response { self.map(Body::from) } } impl ReplySealed for ::http::StatusCode { #[inline] fn into_response(self) -> Response { let mut res = Response::default(); *res.status_mut() = self; res } } impl<T> ReplySealed for Result<T, ::http::Error> where T: Reply + Send, { #[inline] fn into_response(self) -> Response { match self { Ok(t) => t.into_response(), Err(e) => { warn!("reply error: {:?}", e); ::reject::server_error() .into_response() } } } } impl ReplySealed for String { #[inline] fn into_response(self) -> Response { Response::new(Body::from(self)) } } impl ReplySealed for &'static str { #[inline] fn into_response(self) -> Response { Response::new(Body::from(self)) } } impl<T, U> ReplySealed 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> ReplySealed for One<T> where T: Reply, { #[inline] fn into_response(self) -> Response { self.0.into_response() } } impl ReplySealed for ::never::Never { #[inline(always)] fn into_response(self) -> Response { match self {} } } }