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
use crate::http::{ self, headers::{self, HeaderName, HeaderValues, ToHeaderValues}, Body, Method, Mime, Url, }; use crate::RequestBuilder; use serde::Serialize; use std::fmt; use std::ops::Index; /// An HTTP request, returns a `Response`. #[derive(Clone)] pub struct Request { /// Holds the state of the request. req: http_client::Request, } impl Request { /// Create a new instance. /// /// This method is particularly useful when input URLs might be passed by third parties, and /// you don't want to panic if they're malformed. If URLs are statically encoded, it might be /// easier to use one of the shorthand methods instead. /// /// # Examples /// /// ```no_run /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// use surf::http::{Url, Method}; /// /// let url = Url::parse("https://httpbin.org/get")?; /// let req = surf::Request::new(Method::Get, url); /// # Ok(()) } /// ``` pub fn new(method: Method, url: Url) -> Self { let req = http_client::Request::new(method, url); Self { req } } /// Begin a chained request builder. For more details, see [RequestBuilder](crate::RequestBuilder) /// /// # Example: /// ```rust /// use surf::http::{Method, mime::HTML, Url}; /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let url = Url::parse("https://httpbin.org/post")?; /// let mut request = surf::Request::builder(Method::Post, url.clone()) /// .body("<html>hi</html>") /// .header("custom-header", "value") /// .content_type(HTML) /// .build(); /// /// assert_eq!(request.take_body().into_string().await.unwrap(), "<html>hi</html>"); /// assert_eq!(request.method(), Method::Post); /// assert_eq!(request.url(), &url); /// assert_eq!(request["custom-header"], "value"); /// assert_eq!(request["content-type"], "text/html;charset=utf-8"); /// # Ok(()) /// # } /// ``` #[must_use] pub fn builder(method: Method, url: Url) -> RequestBuilder { RequestBuilder::new(method, url) } /// Get the URL querystring. /// /// # Examples /// /// ```no_run /// # use serde::{Deserialize, Serialize}; /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// #[derive(Serialize, Deserialize)] /// struct Index { /// page: u32 /// } /// /// let req = surf::get("https://httpbin.org/get?page=2").build(); /// let Index { page } = req.query()?; /// assert_eq!(page, 2); /// # Ok(()) } /// ``` pub fn query<T: serde::de::DeserializeOwned>(&self) -> crate::Result<T> { self.req.query() } /// Set the URL querystring. /// /// # Examples /// /// ```no_run /// # use serde::{Deserialize, Serialize}; /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// #[derive(Serialize, Deserialize)] /// struct Index { /// page: u32 /// } /// /// let query = Index { page: 2 }; /// let mut req = surf::get("https://httpbin.org/get").build(); /// req.set_query(&query)?; /// assert_eq!(req.url().query(), Some("page=2")); /// assert_eq!(req.as_ref().url().as_str(), "https://httpbin.org/get?page=2"); /// # Ok(()) } /// ``` pub fn set_query(&mut self, query: &impl Serialize) -> crate::Result<()> { self.req.set_query(query) } /// Get an HTTP header. /// /// # Examples /// /// ```no_run /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let mut req = surf::get("https://httpbin.org/get").build(); /// req.set_header("X-Requested-With", "surf"); /// assert_eq!(req.header("X-Requested-With").unwrap(), "surf"); /// # Ok(()) } /// ``` pub fn header(&self, key: impl Into<HeaderName>) -> Option<&HeaderValues> { self.req.header(key) } /// Get a mutable reference to a header. pub fn header_mut(&mut self, name: impl Into<HeaderName>) -> Option<&mut HeaderValues> { self.req.header_mut(name) } /// Set an HTTP header. pub fn insert_header( &mut self, name: impl Into<HeaderName>, values: impl ToHeaderValues, ) -> Option<HeaderValues> { self.req.insert_header(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. pub fn append_header(&mut self, name: impl Into<HeaderName>, values: impl ToHeaderValues) { self.req.append_header(name, values) } /// Remove a header. pub fn remove_header(&mut self, name: impl Into<HeaderName>) -> Option<HeaderValues> { self.req.remove_header(name) } /// An iterator visiting all header pairs in arbitrary order. #[must_use] pub fn iter(&self) -> headers::Iter<'_> { self.req.iter() } /// An iterator visiting all header pairs in arbitrary order, with mutable references to the /// values. #[must_use] pub fn iter_mut(&mut self) -> headers::IterMut<'_> { self.req.iter_mut() } /// An iterator visiting all header names in arbitrary order. #[must_use] pub fn header_names(&self) -> headers::Names<'_> { self.req.header_names() } /// An iterator visiting all header values in arbitrary order. #[must_use] pub fn header_values(&self) -> headers::Values<'_> { self.req.header_values() } /// Set an HTTP header. /// /// # Examples /// /// ```no_run /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let mut req = surf::get("https://httpbin.org/get").build(); /// req.set_header("X-Requested-With", "surf"); /// assert_eq!(req.header("X-Requested-With").unwrap(), "surf"); /// # Ok(()) } /// ``` pub fn set_header(&mut self, key: impl Into<HeaderName>, value: impl ToHeaderValues) { self.insert_header(key, value); } /// Get a request extension value. #[must_use] pub fn ext<T: Send + Sync + 'static>(&self) -> Option<&T> { self.req.ext().get() } /// Set a request extension value. pub fn set_ext<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T> { self.req.ext_mut().insert(val) } /// Get the request HTTP method. /// /// # Examples /// /// ```no_run /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let req = surf::get("https://httpbin.org/get").build(); /// assert_eq!(req.method(), surf::http::Method::Get); /// # Ok(()) } /// ``` pub fn method(&self) -> Method { self.req.method() } /// Get the request url. /// /// # Examples /// /// ```no_run /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// use surf::http::Url; /// let req = surf::get("https://httpbin.org/get").build(); /// assert_eq!(req.url(), &Url::parse("https://httpbin.org/get")?); /// # Ok(()) } /// ``` pub fn url(&self) -> &Url { self.req.url() } /// Get the request content type as a `Mime`. /// /// Gets the `Content-Type` header and parses it to a `Mime` type. /// /// [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) /// /// # Panics /// /// This method will panic if an invalid MIME type was set as a header. Use the [`set_header`] /// method to bypass any checks. /// /// [`set_header`]: #method.set_header pub fn content_type(&self) -> Option<Mime> { self.req.content_type() } /// Set the request content type from a `Mime`. /// /// [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) pub fn set_content_type(&mut self, mime: Mime) { self.req.set_content_type(mime); } /// 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.req.len() } /// Returns `true` if the set length of the body stream is zero, `false` /// otherwise. pub fn is_empty(&self) -> Option<bool> { self.req.is_empty() } /// Pass an `AsyncRead` stream as the request body. /// /// # Mime /// /// The encoding is set to `application/octet-stream`. pub fn set_body(&mut self, body: impl Into<Body>) { self.req.set_body(body) } /// Take the request body as a `Body`. /// /// This method can be called after the body has already been taken or read, /// but will return an empty `Body`. /// /// This is useful for consuming the body via an AsyncReader or AsyncBufReader. pub fn take_body(&mut self) -> Body { self.req.take_body() } /// Pass JSON as the request body. /// /// # Mime /// /// The encoding is set to `application/json`. /// /// # Errors /// /// This method will return an error if the provided data could not be serialized to JSON. pub fn body_json(&mut self, json: &impl Serialize) -> crate::Result<()> { self.set_body(Body::from_json(json)?); Ok(()) } /// Pass a string as the request body. /// /// # Mime /// /// The encoding is set to `text/plain; charset=utf-8`. pub fn body_string(&mut self, string: String) { self.set_body(Body::from_string(string)) } /// Pass bytes as the request body. /// /// # Mime /// /// The encoding is set to `application/octet-stream`. pub fn body_bytes(&mut self, bytes: impl AsRef<[u8]>) { self.set_body(Body::from(bytes.as_ref())) } /// Pass a file as the request body. /// /// # Mime /// /// The encoding is set based on the file extension using [`mime_guess`] if the operation was /// successful. If `path` has no extension, or its extension has no known MIME type mapping, /// then `None` is returned. /// /// [`mime_guess`]: https://docs.rs/mime_guess /// /// # Errors /// /// This method will return an error if the file couldn't be read. #[cfg(not(target_arch = "wasm32"))] pub async fn body_file(&mut self, path: impl AsRef<std::path::Path>) -> std::io::Result<()> { self.set_body(Body::from_file(path).await?); Ok(()) } /// Pass a form as the request body. /// /// # Mime /// /// The encoding is set to `application/x-www-form-urlencoded`. /// /// # Errors /// /// An error will be returned if the encoding failed. pub fn body_form(&mut self, form: &impl Serialize) -> crate::Result<()> { self.set_body(Body::from_form(form)?); Ok(()) } } impl AsRef<http::Request> for Request { fn as_ref(&self) -> &http::Request { &self.req } } impl AsMut<http::Request> for Request { fn as_mut(&mut self) -> &mut http::Request { &mut self.req } } impl From<http::Request> for Request { /// Converts an `http::Request` to a `surf::Request`. fn from(req: http::Request) -> Self { Self { req } } } impl Into<http::Request> for Request { /// Converts a `surf::Request` to an `http::Request`. fn into(self) -> http::Request { self.req } } impl fmt::Debug for Request { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fmt::Debug::fmt(&self.req, f) } } impl IntoIterator for Request { type Item = (HeaderName, HeaderValues); type IntoIter = headers::IntoIter; /// Returns a iterator of references over the remaining items. #[inline] fn into_iter(self) -> Self::IntoIter { self.req.into_iter() } } impl<'a> IntoIterator for &'a Request { type Item = (&'a HeaderName, &'a HeaderValues); type IntoIter = headers::Iter<'a>; #[inline] fn into_iter(self) -> Self::IntoIter { self.req.iter() } } impl<'a> IntoIterator for &'a mut Request { type Item = (&'a HeaderName, &'a mut HeaderValues); type IntoIter = headers::IterMut<'a>; #[inline] fn into_iter(self) -> Self::IntoIter { self.req.iter_mut() } } impl Index<HeaderName> for Request { type Output = HeaderValues; /// Returns a reference to the value corresponding to the supplied name. /// /// # Panics /// /// Panics if the name is not present in `Request`. #[inline] fn index(&self, name: HeaderName) -> &HeaderValues { &self.req[name] } } impl Index<&str> for Request { type Output = HeaderValues; /// Returns a reference to the value corresponding to the supplied name. /// /// # Panics /// /// Panics if the name is not present in `Request`. #[inline] fn index(&self, name: &str) -> &HeaderValues { &self.req[name] } }