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
use async_std::io::{self, BufRead, Read}; use async_std::sync; use std::convert::TryInto; use std::mem; use std::pin::Pin; use std::task::{Context, Poll}; use crate::headers::{ self, HeaderName, HeaderValue, Headers, Names, ToHeaderValues, Values, CONTENT_TYPE, }; use crate::mime::Mime; use crate::trailers::{Trailers, TrailersSender}; use crate::Cookie; use crate::{Body, Method, TypeMap, Url, Version}; pin_project_lite::pin_project! { /// An HTTP request. /// /// # Examples /// /// ``` /// use http_types::{Url, Method, Request}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap()); /// req.set_body("Hello, Nori!"); /// ``` #[derive(Debug)] pub struct Request { method: Method, url: Url, headers: Headers, version: Option<Version>, sender: Option<sync::Sender<crate::Result<Trailers>>>, receiver: sync::Receiver<crate::Result<Trailers>>, #[pin] body: Body, local: TypeMap, } } impl Request { /// Create a new request. pub fn new(method: Method, url: Url) -> Self { let (sender, receiver) = sync::channel(1); Self { method, url, headers: Headers::new(), version: None, body: Body::empty(), sender: Some(sender), receiver, local: TypeMap::new(), } } /// Get the HTTP method pub fn method(&self) -> Method { self.method } /// Set the HTTP method. pub fn set_method(&mut self, method: Method) { self.method = method; } /// Get a reference to the url. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), http_types::Error> { /// # /// use http_types::{Url, Method, Request, Response, StatusCode}; /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// assert_eq!(req.url().scheme(), "https"); /// # /// # Ok(()) } /// ``` pub fn url(&self) -> &Url { &self.url } /// Get a mutable reference to the url. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), http_types::Error> { /// # /// use http_types::{Url, Method, Request, Response, StatusCode}; /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.url_mut().set_scheme("http"); /// assert_eq!(req.url().scheme(), "http"); /// # /// # Ok(()) } /// ``` pub fn url_mut(&mut self) -> &mut Url { &mut self.url } /// Set the request body. /// /// # Examples /// /// ``` /// use http_types::{Url, Method, Request}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap()); /// req.set_body("Hello, Nori!"); /// ``` pub fn set_body(&mut self, body: impl Into<Body>) { self.replace_body(body); } /// Swaps the value of the body with another body, without deinitializing /// either one. /// /// # Examples /// /// ``` /// # use async_std::io::prelude::*; /// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> { /// # async_std::task::block_on(async { /// # /// use http_types::{Body, Url, Method, Request}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap()); /// req.set_body("Hello, Nori!"); /// let mut body: Body = req.replace_body("Hello, Chashu!"); /// /// let mut string = String::new(); /// body.read_to_string(&mut string).await?; /// assert_eq!(&string, "Hello, Nori!"); /// # /// # Ok(()) }) } /// ``` pub fn replace_body(&mut self, body: impl Into<Body>) -> Body { let body = mem::replace(&mut self.body, body.into()); self.copy_content_type_from_body(); body } /// Replace the request body with a new body, and return the old body. /// /// # Examples /// /// ``` /// # use async_std::io::prelude::*; /// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> { /// # async_std::task::block_on(async { /// # /// use http_types::{Body, Url, Method, Request}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap()); /// req.set_body("Hello, Nori!"); /// let mut body = "Hello, Chashu!".into(); /// req.swap_body(&mut body); /// /// let mut string = String::new(); /// body.read_to_string(&mut string).await?; /// assert_eq!(&string, "Hello, Nori!"); /// # /// # Ok(()) }) } /// ``` pub fn swap_body(&mut self, body: &mut Body) { mem::swap(&mut self.body, body); self.copy_content_type_from_body(); } /// Take the request body, replacing it with an empty body. /// /// # Examples /// /// ``` /// # use async_std::io::prelude::*; /// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> { /// # async_std::task::block_on(async { /// # /// use http_types::{Body, Url, Method, Request}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap()); /// req.set_body("Hello, Nori!"); /// let mut body: Body = req.take_body(); /// /// let mut string = String::new(); /// body.read_to_string(&mut string).await?; /// assert_eq!(&string, "Hello, Nori!"); /// /// # let mut string = String::new(); /// # req.read_to_string(&mut string).await?; /// # assert_eq!(&string, ""); /// # /// # Ok(()) }) } /// ``` pub fn take_body(&mut self) -> Body { self.replace_body(Body::empty()) } /// Read the body as a string. /// /// This consumes the request. If you want to read the body without /// consuming the request, consider using the `take_body` method and /// then calling `Body::into_string` or using the Request's AsyncRead /// implementation to read the body. /// /// # Examples /// /// ``` /// # use std::io::prelude::*; /// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> { /// # async_std::task::block_on(async { /// use http_types::{Body, Url, Method, Request}; /// use async_std::io::Cursor; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com").unwrap()); /// /// let cursor = Cursor::new("Hello Nori"); /// let body = Body::from_reader(cursor, None); /// req.set_body(body); /// assert_eq!(&req.body_string().await.unwrap(), "Hello Nori"); /// # Ok(()) }) } /// ``` pub async fn body_string(self) -> io::Result<String> { self.body.into_string().await } /// Get an HTTP header. pub fn header(&self, name: &HeaderName) -> Option<&Vec<HeaderValue>> { self.headers.get(name) } /// Get a mutable reference to a header. pub fn header_mut(&mut self, name: &HeaderName) -> Option<&mut Vec<HeaderValue>> { self.headers.get_mut(name) } /// Remove a header. pub fn remove_header(&mut self, name: &HeaderName) -> Option<Vec<HeaderValue>> { self.headers.remove(name) } /// Set an HTTP header. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> { /// # /// use http_types::{Url, Method, Request}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.insert_header("Content-Type", "text/plain")?; /// # /// # Ok(()) } /// ``` pub fn insert_header( &mut self, name: impl TryInto<HeaderName>, values: impl ToHeaderValues, ) -> crate::Result<Option<Vec<HeaderValue>>> { self.headers.insert(name, values) } /// Append a header to the headers. /// /// Unlike `insert` this function will not override the contents of a header, but insert a /// header if there aren't any. Or else append to the existing list of headers. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> { /// # /// use http_types::{Url, Method, Request}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.append_header("Content-Type", "text/plain")?; /// # /// # Ok(()) } /// ``` pub fn append_header( &mut self, name: impl TryInto<HeaderName>, values: impl ToHeaderValues, ) -> crate::Result<()> { self.headers.append(name, values) } /// Set the response MIME. // TODO: return a parsed MIME pub fn set_content_type(&mut self, mime: Mime) -> Option<Vec<HeaderValue>> { let value: HeaderValue = mime.into(); // A Mime instance is guaranteed to be valid header name. self.insert_header(CONTENT_TYPE, value).unwrap() } /// Copy MIME data from the body. fn copy_content_type_from_body(&mut self) { if self.header(&CONTENT_TYPE).is_none() { self.set_content_type(self.body.mime().clone()); } } /// Get the current content type pub fn content_type(&self) -> Option<Mime> { self.header(&CONTENT_TYPE)?.last()?.as_str().parse().ok() } /// Get the length of the body stream, if it has been set. /// /// This value is set when passing a fixed-size object into as the body. E.g. a string, or a /// buffer. Consumers of this API should check this value to decide whether to use `Chunked` /// encoding, or set the response length. pub fn len(&self) -> Option<usize> { self.body.len() } /// Returns `true` if the request has a set body stream length of zero, `false` otherwise. pub fn is_empty(&self) -> Option<bool> { self.body.is_empty() } /// Get the HTTP version, if one has been set. /// /// # Examples /// /// ``` /// use http_types::{Url, Method, Request, Version}; /// /// # fn main() -> Result<(), http_types::Error> { /// # /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// assert_eq!(req.version(), None); /// /// req.set_version(Some(Version::Http2_0)); /// assert_eq!(req.version(), Some(Version::Http2_0)); /// # /// # Ok(()) } /// ``` pub fn version(&self) -> Option<Version> { self.version } /// Set the HTTP version. /// /// # Examples /// /// ``` /// use http_types::{Url, Method, Request, Version}; /// /// # fn main() -> Result<(), http_types::Error> { /// # /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.set_version(Some(Version::Http2_0)); /// # /// # Ok(()) } /// ``` pub fn set_version(&mut self, version: Option<Version>) { self.version = version; } /// Get all cookies. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), http_types::Error> { /// # /// use http_types::{Cookie, Url, Method, Request, Version}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.set_cookie(Cookie::new("name", "value")); /// assert_eq!(req.cookies().unwrap(), vec![Cookie::new("name", "value")]); /// # /// # Ok(()) } /// ``` pub fn cookies(&self) -> Result<Vec<Cookie<'_>>, crate::Error> { match self.header(&headers::COOKIE) { None => Ok(vec![]), Some(h) => h.iter().try_fold(vec![], |mut acc, h| { let cookie = Cookie::parse(h.as_str())?; acc.push(cookie); Ok(acc) }), } } /// Get a cookie by name. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), http_types::Error> { /// # /// use http_types::{Cookie, Url, Method, Request, Version}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.set_cookie(Cookie::new("name", "value")); /// assert_eq!(req.cookie("name").unwrap(), Some(Cookie::new("name", "value"))); /// # /// # Ok(()) } /// ``` pub fn cookie(&self, name: &str) -> Result<Option<Cookie<'_>>, crate::Error> { let cookies = self.cookies()?; let cookie = cookies.into_iter().find(|c| c.name() == name); Ok(cookie) } /// Set a cookie. /// /// This will not override any existing cookies, and uses the `Cookies` header. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), http_types::Error> { /// # /// use http_types::{Cookie, Url, Method, Request, Version}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.set_cookie(Cookie::new("name", "value")); /// # /// # Ok(()) } /// ``` pub fn set_cookie(&mut self, cookie: Cookie<'_>) { self.append_header(headers::COOKIE, HeaderValue::from(cookie)) .unwrap(); } /// Sends trailers to the a receiver. pub fn send_trailers(&mut self) -> TrailersSender { let sender = self .sender .take() .expect("Trailers sender can only be constructed once"); TrailersSender::new(sender) } /// Receive trailers from a sender. pub async fn recv_trailers(&self) -> Option<crate::Result<Trailers>> { self.receiver.recv().await.ok() } /// An iterator visiting all header pairs in arbitrary order. pub fn iter(&self) -> headers::Iter<'_> { self.headers.iter() } /// An iterator visiting all header pairs in arbitrary order, with mutable references to the /// values. pub fn iter_mut(&mut self) -> headers::IterMut<'_> { self.headers.iter_mut() } /// An iterator visiting all header names in arbitrary order. pub fn header_names(&self) -> Names<'_> { self.headers.names() } /// An iterator visiting all header values in arbitrary order. pub fn header_values(&self) -> Values<'_> { self.headers.values() } /// Returns a reference to the existing local state. pub fn local(&self) -> &TypeMap { &self.local } /// Returns a mutuable reference to the existing local state. /// /// /// # Examples /// /// ``` /// # fn main() -> Result<(), http_types::Error> { /// # /// use http_types::{Url, Method, Request, Version}; /// /// let mut req = Request::new(Method::Get, Url::parse("https://example.com")?); /// req.local_mut().insert("hello from the extension"); /// assert_eq!(req.local().get(), Some(&"hello from the extension")); /// # /// # Ok(()) } /// ``` pub fn local_mut(&mut self) -> &mut TypeMap { &mut self.local } } impl Read for Request { #[allow(missing_doc_code_examples)] fn poll_read( mut self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<io::Result<usize>> { Pin::new(&mut self.body).poll_read(cx, buf) } } impl BufRead for Request { #[allow(missing_doc_code_examples)] fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&'_ [u8]>> { let this = self.project(); this.body.poll_fill_buf(cx) } fn consume(mut self: Pin<&mut Self>, amt: usize) { Pin::new(&mut self.body).consume(amt) } } impl AsRef<Headers> for Request { fn as_ref(&self) -> &Headers { &self.headers } } impl AsMut<Headers> for Request { fn as_mut(&mut self) -> &mut Headers { &mut self.headers } } impl From<Request> for Body { fn from(req: Request) -> Body { req.body } } impl IntoIterator for Request { type Item = (HeaderName, Vec<HeaderValue>); type IntoIter = headers::IntoIter; /// Returns a iterator of references over the remaining items. #[inline] fn into_iter(self) -> Self::IntoIter { self.headers.into_iter() } } impl<'a> IntoIterator for &'a Request { type Item = (&'a HeaderName, &'a Vec<HeaderValue>); type IntoIter = headers::Iter<'a>; #[inline] fn into_iter(self) -> Self::IntoIter { self.headers.iter() } } impl<'a> IntoIterator for &'a mut Request { type Item = (&'a HeaderName, &'a mut Vec<HeaderValue>); type IntoIter = headers::IterMut<'a>; #[inline] fn into_iter(self) -> Self::IntoIter { self.headers.iter_mut() } }