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
use crate::http::{ headers::{HeaderName, ToHeaderValues}, Body, Method, Mime, Url, }; use crate::{Client, Error, Request, Response, Result}; use futures_util::future::BoxFuture; use serde::Serialize; use std::fmt; use std::future::Future; use std::pin::Pin; use std::task::{Context, Poll}; /// Request Builder /// /// Provides an ergonomic way to chain the creation of a request. /// This is generally accessed as the return value from `surf::{method}()`, /// however [`Request::builder`](crate::Request::builder) is also provided. /// /// # Examples /// /// ```rust /// use surf::http::{Method, mime::HTML, Url}; /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let mut request = surf::post("https://httpbin.org/post") /// .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::parse("https://httpbin.org/post")?); /// assert_eq!(request["custom-header"], "value"); /// assert_eq!(request["content-type"], "text/html;charset=utf-8"); /// # Ok(()) /// # } /// ``` /// /// ```rust /// use surf::http::{Method, Url}; /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let url = Url::parse("https://httpbin.org/post")?; /// let request = surf::Request::builder(Method::Post, url).build(); /// # Ok(()) /// # } /// ``` pub struct RequestBuilder { /// Holds the state of the request. req: Option<Request>, /// Hold an optional Client. client: Option<Client>, /// Holds the state of the `impl Future`. fut: Option<BoxFuture<'static, Result<Response>>>, } impl RequestBuilder { /// 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::{Method, Url}; /// /// let url = Url::parse("https://httpbin.org/get")?; /// let req = surf::RequestBuilder::new(Method::Get, url).build(); /// # Ok(()) } /// ``` pub fn new(method: Method, url: Url) -> Self { Self { req: Some(Request::new(method, url)), client: None, fut: None, } } pub(crate) fn with_client(mut self, client: Client) -> Self { self.client = Some(client); self } /// Sets a header on the request. /// /// # Examples /// /// ``` /// let req = surf::get("https://httpbin.org/get").header("header-name", "header-value").build(); /// assert_eq!(req["header-name"], "header-value"); /// ``` pub fn header(mut self, key: impl Into<HeaderName>, value: impl ToHeaderValues) -> Self { self.req.as_mut().unwrap().insert_header(key, value); self } /// Sets the Content-Type header on the request. /// /// # Examples /// /// ``` /// # use surf::http::mime; /// let req = surf::post("https://httpbin.org/post").content_type(mime::HTML).build(); /// assert_eq!(req["content-type"], "text/html;charset=utf-8"); /// ``` pub fn content_type(mut self, content_type: impl Into<Mime>) -> Self { self.req .as_mut() .unwrap() .set_content_type(content_type.into()); self } /// Sets the body of the request. /// /// # Examples /// /// ``` /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// use serde_json::json; /// let mut req = surf::post("https://httpbin.org/post").body(json!({ "any": "Into<Body>"})).build(); /// assert_eq!(req.take_body().into_string().await.unwrap(), "{\"any\":\"Into<Body>\"}"); /// # Ok(()) /// # } /// ``` pub fn body(mut self, body: impl Into<Body>) -> Self { self.req.as_mut().unwrap().set_body(body); self } /// 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").query(&query)?.build(); /// 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 query(mut self, query: &impl Serialize) -> std::result::Result<Self, Error> { self.req.as_mut().unwrap().set_query(query)?; Ok(self) } /// Submit the request and get the response body as bytes. /// /// # Examples /// /// ```no_run /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let bytes = surf::get("https://httpbin.org/get").recv_bytes().await?; /// assert!(bytes.len() > 0); /// # Ok(()) } /// ``` pub async fn recv_bytes(self) -> Result<Vec<u8>> { let mut res = self.send().await?; Ok(res.body_bytes().await?) } /// Submit the request and get the response body as a string. /// /// # Examples /// /// ```no_run /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// let string = surf::get("https://httpbin.org/get").recv_string().await?; /// assert!(string.len() > 0); /// # Ok(()) } /// ``` pub async fn recv_string(self) -> Result<String> { let mut res = self.send().await?; Ok(res.body_string().await?) } /// Submit the request and decode the response body from json into a struct. /// /// # Examples /// /// ```no_run /// # use serde::{Deserialize, Serialize}; /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// #[derive(Deserialize, Serialize)] /// struct Ip { /// ip: String /// } /// /// let uri = "https://api.ipify.org?format=json"; /// let Ip { ip } = surf::get(uri).recv_json().await?; /// assert!(ip.len() > 10); /// # Ok(()) } /// ``` pub async fn recv_json<T: serde::de::DeserializeOwned>(self) -> Result<T> { let mut res = self.send().await?; Ok(res.body_json::<T>().await?) } /// Submit the request and decode the response body from form encoding into a struct. /// /// # Errors /// /// Any I/O error encountered while reading the body is immediately returned /// as an `Err`. /// /// If the body cannot be interpreted as valid json for the target type `T`, /// an `Err` is returned. /// /// # Examples /// /// ```no_run /// # use serde::{Deserialize, Serialize}; /// # #[async_std::main] /// # async fn main() -> surf::Result<()> { /// #[derive(Deserialize, Serialize)] /// struct Body { /// apples: u32 /// } /// /// let url = "https://api.example.com/v1/response"; /// let Body { apples } = surf::get(url).recv_form().await?; /// # Ok(()) } /// ``` pub async fn recv_form<T: serde::de::DeserializeOwned>(self) -> Result<T> { let mut res = self.send().await?; Ok(res.body_form::<T>().await?) } /// Return the constructed `Request`. pub fn build(self) -> Request { self.req.unwrap() } /// Create a `Client` and send the constructed `Request` from it. pub async fn send(mut self) -> Result<Response> { self.client .take() .unwrap_or_else(Client::new_shared_or_panic) .send(self.build()) .await } } impl fmt::Debug for RequestBuilder { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fmt::Debug::fmt(&self.req, f) } } impl Future for RequestBuilder { type Output = Result<Response>; fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { if self.fut.is_none() { let req = self.req.take().unwrap(); let client = self .client .take() .unwrap_or_else(Client::new_shared_or_panic); self.fut = Some(Box::pin(async move { client.send(req).await })) } // We can safely unwrap here because this is the only time we take ownership of the request. self.fut.as_mut().unwrap().as_mut().poll(cx) } } impl Into<Request> for RequestBuilder { /// Converts a `surf::RequestBuilder` to a `surf::Request`. fn into(self) -> Request { self.build() } }