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
use std::fmt; use std::rc::Rc; use std::mem::transmute; use std::net::SocketAddr; use std::ops::{Deref, DerefMut}; use {Rocket, Request, Response, Data}; use http::{Header, Cookie}; /// A structure representing a local request as created by [`Client`]. /// /// # Usage /// /// A `LocalRequest` value is constructed via method constructors on [`Client`]. /// Headers can be added via the [`header`] builder method and the /// [`add_header`] method. Cookies can be added via the [`cookie`] builder /// method. The remote IP address can be set via the [`remote`] builder method. /// The body of the request can be set via the [`body`] builder method or /// [`set_body`] method. /// /// ## Example /// /// The following snippet uses the available builder methods to construct a /// `POST` request to `/` with a JSON body: /// /// ```rust /// use rocket::local::Client; /// use rocket::http::{ContentType, Cookie}; /// /// let client = Client::new(rocket::ignite()).expect("valid rocket"); /// let req = client.post("/") /// .header(ContentType::JSON) /// .remote("127.0.0.1:8000".parse().unwrap()) /// .cookie(Cookie::new("name", "value")) /// .body(r#"{ "value": 42 }"#); /// ``` /// /// # Dispatching /// /// A `LocalRequest` can be dispatched in one of three ways: /// /// 1. [`dispatch`] /// /// This method should always be preferred. The `LocalRequest` is consumed /// and a response is returned. /// /// 2. [`cloned_dispatch`] /// /// This method should be used when one `LocalRequest` will be dispatched /// many times. This method clones the request and dispatches the clone, so /// the request _is not_ consumed and can be reused. /// /// 3. [`mut_dispatch`] /// /// This method should _only_ be used when either it is known that the /// application will not modify the request, or it is desired to see /// modifications to the request. No cloning occurs, and the request is not /// consumed. /// /// [`Client`]: /rocket/local/struct.Client.html /// [`header`]: #method.header /// [`add_header`]: #method.add_header /// [`cookie`]: #method.cookie /// [`remote`]: #method.remote /// [`body`]: #method.body /// [`set_body`]: #method.set_body /// [`dispatch`]: #method.dispatch /// [`mut_dispatch`]: #method.mut_dispatch /// [`cloned_dispatch`]: #method.cloned_dispatch pub struct LocalRequest<'c> { rocket: &'c Rocket, ptr: *mut Request<'c>, request: Rc<Request<'c>>, data: Vec<u8> } impl<'c> LocalRequest<'c> { #[inline(always)] pub(crate) fn new(rocket: &'c Rocket, request: Request<'c>) -> LocalRequest<'c> { let mut req = Rc::new(request); let ptr = Rc::get_mut(&mut req).unwrap() as *mut Request; LocalRequest { rocket: rocket, ptr: ptr, request: req, data: vec![] } } /// Retrieves the inner `Request` as seen by Rocket. /// /// # Example /// /// ```rust /// use rocket::local::Client; /// /// let client = Client::new(rocket::ignite()).expect("valid rocket"); /// let req = client.get("/"); /// let inner_req = req.inner(); /// ``` #[inline] pub fn inner(&self) -> &Request<'c> { &*self.request } #[inline(always)] fn request(&mut self) -> &mut Request<'c> { unsafe { &mut *self.ptr } } /// Add a header to this request. /// /// Any type that implements `Into<Header>` can be used here. Among others, /// this includes [`ContentType`] and [`Accept`]. /// /// [`ContentType`]: /rocket/http/struct.ContentType.html /// [`Accept`]: /rocket/http/struct.Accept.html /// /// # Examples /// /// Add the Content-Type header: /// /// ```rust /// use rocket::local::Client; /// use rocket::http::ContentType; /// /// # #[allow(unused_variables)] /// let client = Client::new(rocket::ignite()).unwrap(); /// let req = client.get("/").header(ContentType::JSON); /// ``` #[inline] pub fn header<H: Into<Header<'static>>>(mut self, header: H) -> Self { self.request().add_header(header.into()); self } /// Adds a header to this request without consuming `self`. /// /// # Examples /// /// Add the Content-Type header: /// /// ```rust /// use rocket::local::Client; /// use rocket::http::ContentType; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// let mut req = client.get("/"); /// req.add_header(ContentType::JSON); /// ``` #[inline] pub fn add_header<H: Into<Header<'static>>>(&mut self, header: H) { self.request().add_header(header.into()); } /// Set the remote address of this request. /// /// # Examples /// /// Set the remote address to "8.8.8.8:80": /// /// ```rust /// use rocket::local::Client; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// let address = "8.8.8.8:80".parse().unwrap(); /// let req = client.get("/").remote(address); /// ``` #[inline] pub fn remote(mut self, address: SocketAddr) -> Self { self.request().set_remote(address); self } /// Add a cookie to this request. /// /// # Examples /// /// Add `user_id` cookie: /// /// ```rust /// use rocket::local::Client; /// use rocket::http::Cookie; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// # #[allow(unused_variables)] /// let req = client.get("/") /// .cookie(Cookie::new("username", "sb")) /// .cookie(Cookie::new("user_id", "12")); /// ``` #[inline] pub fn cookie(self, cookie: Cookie<'static>) -> Self { self.request.cookies().add_original(cookie); self } // TODO: For CGI, we want to be able to set the body to be stdin without // actually reading everything into a vector. Can we allow that here while // keeping the simplicity? Looks like it would require us to reintroduce a // NetStream::Local(Box<Read>) or something like that. /// Set the body (data) of the request. /// /// # Examples /// /// Set the body to be a JSON structure; also sets the Content-Type. /// /// ```rust /// use rocket::local::Client; /// use rocket::http::ContentType; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// # #[allow(unused_variables)] /// let req = client.post("/") /// .header(ContentType::JSON) /// .body(r#"{ "key": "value", "array": [1, 2, 3], }"#); /// ``` #[inline] pub fn body<S: AsRef<[u8]>>(mut self, body: S) -> Self { self.data = body.as_ref().into(); self } /// Set the body (data) of the request without consuming `self`. /// /// # Examples /// /// Set the body to be a JSON structure; also sets the Content-Type. /// /// ```rust /// use rocket::local::Client; /// use rocket::http::ContentType; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// let mut req = client.post("/").header(ContentType::JSON); /// req.set_body(r#"{ "key": "value", "array": [1, 2, 3], }"#); /// ``` #[inline] pub fn set_body<S: AsRef<[u8]>>(&mut self, body: S) { self.data = body.as_ref().into(); } /// Dispatches the request, returning the response. /// /// This method consumes `self` and is the preferred mechanism for /// dispatching. /// /// # Example /// /// ```rust /// use rocket::local::Client; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// let response = client.get("/").dispatch(); /// ``` #[inline(always)] pub fn dispatch(mut self) -> LocalResponse<'c> { let req = unsafe { transmute(self.request()) }; let response = self.rocket.dispatch(req, Data::local(self.data)); LocalResponse { _request: self.request, response: response } } /// Dispatches the request, returning the response. /// /// This method _does not_ consume `self`. Instead, it clones `self` and /// dispatches the clone. As such, `self` can be reused. /// /// # Example /// /// ```rust /// use rocket::local::Client; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// /// let req = client.get("/"); /// let response_a = req.cloned_dispatch(); /// let response_b = req.cloned_dispatch(); /// ``` #[inline(always)] pub fn cloned_dispatch(&self) -> LocalResponse<'c> { let cloned = (*self.request).clone(); let mut req = LocalRequest::new(self.rocket, cloned); req.data = self.data.clone(); req.dispatch() } /// Dispatches the request, returning the response. /// /// This method _does not_ consume or clone `self`. Any changes to the /// request that occur during handling will be visible after this method is /// called. For instance, body data is always consumed after a request is /// dispatched. As such, only the first call to `mut_dispatch` for a given /// `LocalRequest` will contains the original body data. /// /// This method should _only_ be used when either it is known that /// the application will not modify the request, or it is desired to see /// modifications to the request. Prefer to use [`dispatch`] or /// [`cloned_dispatch`] instead /// /// [`dispatch`]: #method.dispatch /// [`cloned_dispatch`]: #method.cloned_dispatch /// /// # Example /// /// ```rust /// use rocket::local::Client; /// /// let client = Client::new(rocket::ignite()).unwrap(); /// /// let mut req = client.get("/"); /// let response_a = req.mut_dispatch(); /// let response_b = req.mut_dispatch(); /// ``` #[inline(always)] pub fn mut_dispatch(&mut self) -> LocalResponse<'c> { let data = ::std::mem::replace(&mut self.data, vec![]); let req = unsafe { transmute(self.request()) }; let response = self.rocket.dispatch(req, Data::local(data)); LocalResponse { _request: self.request.clone(), response: response } } } impl<'c> fmt::Debug for LocalRequest<'c> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(&self.request, f) } } /// A structure representing a response from dispatching a local request. /// /// This structure is a thin wrapper around [`Response`]. It implements no /// methods of its own; all functionality is exposed via the `Deref` and /// `DerefMut` implementations with a target of `Response`. In other words, when /// invoking methods, a `LocalResponse` can be treated exactly as if it were a /// `Response`. /// /// [`Response`]: /rocket/struct.Response.html pub struct LocalResponse<'c> { _request: Rc<Request<'c>>, response: Response<'c>, } impl<'c> Deref for LocalResponse<'c> { type Target = Response<'c>; #[inline(always)] fn deref(&self) -> &Response<'c> { &self.response } } impl<'c> DerefMut for LocalResponse<'c> { #[inline(always)] fn deref_mut(&mut self) -> &mut Response<'c> { &mut self.response } } impl<'c> fmt::Debug for LocalResponse<'c> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(&self.response, f) } } // fn test() { // use local::Client; // let rocket = Rocket::ignite(); // let res = { // let mut client = Client::new(rocket).unwrap(); // client.get("/").dispatch() // }; // // let client = Client::new(rocket).unwrap(); // // let res1 = client.get("/").dispatch(); // // let res2 = client.get("/").dispatch(); // } // fn test() { // use local::Client; // let rocket = Rocket::ignite(); // let res = { // Client::new(rocket).unwrap() // .get("/").dispatch(); // }; // // let client = Client::new(rocket).unwrap(); // // let res1 = client.get("/").dispatch(); // // let res2 = client.get("/").dispatch(); // } // fn test() { // use local::Client; // let rocket = Rocket::ignite(); // let client = Client::new(rocket).unwrap(); // let res = { // let x = client.get("/").dispatch(); // let y = client.get("/").dispatch(); // }; // let x = client; // } // fn test() { // use local::Client; // let rocket1 = Rocket::ignite(); // let rocket2 = Rocket::ignite(); // let client1 = Client::new(rocket1).unwrap(); // let client2 = Client::new(rocket2).unwrap(); // let res = { // let mut res1 = client1.get("/"); // res1.set_client(&client2); // res1 // }; // drop(client1); // }