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
use std::mem; use std::fmt; use std::io::{self, Read}; use std::net::SocketAddr; use std::time::Duration; use std::borrow::Cow; use encoding_rs::{Encoding, UTF_8}; use futures::{Async, Poll, Stream}; use http; use mime::Mime; use serde::de::DeserializeOwned; use serde_json; use client::KeepCoreThreadAlive; use hyper::header::HeaderMap; use {async_impl, StatusCode, Url, Version, wait}; /// A Response to a submitted `Request`. pub struct Response { inner: async_impl::Response, body: async_impl::ReadableChunks<WaitBody>, content_length: Option<u64>, _thread_handle: KeepCoreThreadAlive, } impl fmt::Debug for Response { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(&self.inner, f) } } impl Response { pub(crate) fn new(mut res: async_impl::Response, timeout: Option<Duration>, thread: KeepCoreThreadAlive) -> Response { let body = mem::replace(res.body_mut(), async_impl::Decoder::empty()); let len = body.content_length(); let body = async_impl::ReadableChunks::new(WaitBody { inner: wait::stream(body, timeout) }); Response { inner: res, body: body, content_length: len, _thread_handle: thread, } } /// Get the final `Url` of this `Response`. /// /// # Example /// /// ```rust /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let resp = reqwest::get("http://httpbin.org/redirect/1")?; /// assert_eq!(resp.url().as_str(), "http://httpbin.org/get"); /// # Ok(()) /// # } /// ``` #[inline] pub fn url(&self) -> &Url { self.inner.url() } /// Get the remote address used to get this `Response`. /// /// # Example /// /// ```rust /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let resp = reqwest::get("http://httpbin.org/redirect/1")?; /// println!("httpbin.org address: {:?}", resp.remote_addr()); /// # Ok(()) /// # } /// ``` pub fn remote_addr(&self) -> Option<SocketAddr> { self.inner.remote_addr() } /// Get the `StatusCode` of this `Response`. /// /// # Examples /// /// ```rust /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let resp = reqwest::get("http://httpbin.org/get")?; /// if resp.status().is_success() { /// println!("success!"); /// } else if resp.status().is_server_error() { /// println!("server error!"); /// } else { /// println!("Something else happened. Status: {:?}", resp.status()); /// } /// # Ok(()) /// # } /// ``` /// /// ```rust /// use reqwest::Client; /// use reqwest::StatusCode; /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let client = Client::new(); /// let resp = client.post("http://httpbin.org/post") /// .body("possibly too large") /// .send()?; /// match resp.status() { /// StatusCode::OK => println!("success!"), /// StatusCode::PAYLOAD_TOO_LARGE => { /// println!("Request payload is too large!"); /// } /// s => println!("Received response status: {:?}", s), /// }; /// # Ok(()) /// # } /// ``` #[inline] pub fn status(&self) -> StatusCode { self.inner.status() } /// Get the `Headers` of this `Response`. /// /// # Example /// /// Checking the `Content-Length` header before reading the response body. /// /// ```rust /// # use std::io::{Read, Write}; /// # use reqwest::Client; /// # use reqwest::header::CONTENT_LENGTH; /// # /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let client = Client::new(); /// let mut resp = client.head("http://httpbin.org/bytes/3000").send()?; /// if resp.status().is_success() { /// let len = resp.headers().get(CONTENT_LENGTH) /// .and_then(|ct_len| ct_len.to_str().ok()) /// .and_then(|ct_len| ct_len.parse().ok()) /// .unwrap_or(0); /// // limit 1mb response /// if len <= 1_000_000 { /// let mut buf = Vec::with_capacity(len as usize); /// let mut resp = reqwest::get("http://httpbin.org/bytes/3000")?; /// if resp.status().is_success() { /// ::std::io::copy(&mut resp, &mut buf)?; /// } /// } /// } /// # Ok(()) /// # } /// ``` #[inline] pub fn headers(&self) -> &HeaderMap { self.inner.headers() } /// Get the HTTP `Version` of this `Response`. #[inline] pub fn version(&self) -> Version { self.inner.version() } /// Try and deserialize the response body as JSON using `serde`. /// /// # Examples /// /// ```rust /// # extern crate reqwest; /// # #[macro_use] extern crate serde_derive; /// # /// # use reqwest::Error; /// # /// #[derive(Deserialize)] /// struct Ip { /// origin: String, /// } /// /// # fn run() -> Result<(), Error> { /// let json: Ip = reqwest::get("http://httpbin.org/ip")?.json()?; /// # Ok(()) /// # } /// # /// # fn main() { } /// ``` /// /// # Errors /// /// This method fails whenever the response body is not in JSON format /// or it cannot be properly deserialized to target type `T`. For more /// details please see [`serde_json::from_reader`]. /// [`serde_json::from_reader`]: https://docs.serde.rs/serde_json/fn.from_reader.html #[inline] pub fn json<T: DeserializeOwned>(&mut self) -> ::Result<T> { // There's 2 ways we could implement this: // // 1. Just using from_reader(self), making use of our blocking read adapter // 2. Just use self.inner.json().wait() // // Doing 1 is pretty easy, but it means we have the `serde_json` code // in more than one place, doing basically the same thing. // // Doing 2 would mean `serde_json` is only in one place, but we'd // need to update the sync Response to lazily make a blocking read // adapter, so that our `inner` could possibly still have the original // body. // // Went for easier for now, just to get it working. serde_json::from_reader(self).map_err(::error::from) } /// Get the response text. /// /// This method decodes the response body with BOM sniffing /// and with malformed sequences replaced with the REPLACEMENT CHARACTER. /// Encoding is determinated from the `charset` parameter of `Content-Type` header, /// and defaults to `utf-8` if not presented. /// /// # Example /// /// ```rust /// # extern crate reqwest; /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let content = reqwest::get("http://httpbin.org/range/26")?.text()?; /// # Ok(()) /// # } /// ``` /// /// # Note /// /// This consumes the body. Trying to read more, or use of `response.json()` /// will return empty values. pub fn text(&mut self) -> ::Result<String> { let len = self.content_length.unwrap_or(0); let mut content = Vec::with_capacity(len as usize); self.read_to_end(&mut content).map_err(::error::from)?; let content_type = self.headers().get(::header::CONTENT_TYPE) .and_then(|value| { value.to_str().ok() }) .and_then(|value| { value.parse::<Mime>().ok() }); let encoding_name = content_type .as_ref() .and_then(|mime| { mime .get_param("charset") .map(|charset| charset.as_str()) }) .unwrap_or("utf-8"); let encoding = Encoding::for_label(encoding_name.as_bytes()).unwrap_or(UTF_8); // a block because of borrow checker { let (text, _, _) = encoding.decode(&content); match text { Cow::Owned(s) => return Ok(s), _ => (), } } unsafe { // decoding returned Cow::Borrowed, meaning these bytes // are already valid utf8 Ok(String::from_utf8_unchecked(content)) } } /// Copy the response body into a writer. /// /// This function internally uses [`std::io::copy`] and hence will continuously read data from /// the body and then write it into writer in a streaming fashion until EOF is met. /// /// On success, the total number of bytes that were copied to `writer` is returned. /// [`std::io::copy`]: https://doc.rust-lang.org/std/io/fn.copy.html /// /// # Example /// /// ```rust /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let mut resp = reqwest::get("http://httpbin.org/range/5")?; /// let mut buf: Vec<u8> = vec![]; /// resp.copy_to(&mut buf)?; /// assert_eq!(b"abcde", buf.as_slice()); /// # Ok(()) /// # } /// ``` #[inline] pub fn copy_to<W: ?Sized>(&mut self, w: &mut W) -> ::Result<u64> where W: io::Write { io::copy(self, w).map_err(::error::from) } /// Turn a response into an error if the server returned an error. /// /// # Example /// /// ```rust,no_run /// # extern crate reqwest; /// # fn run() -> Result<(), Box<::std::error::Error>> { /// let res = reqwest::get("http://httpbin.org/status/400")? /// .error_for_status(); /// if let Err(err) = res { /// assert_eq!(err.status(), Some(reqwest::StatusCode::BAD_REQUEST)); /// } /// # Ok(()) /// # } /// # fn main() {} /// ``` #[inline] pub fn error_for_status(self) -> ::Result<Self> { let Response { body, content_length, inner, _thread_handle } = self; inner.error_for_status().map(move |inner| { Response { inner, body, content_length, _thread_handle, } }) } } impl Read for Response { #[inline] fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> { self.body.read(buf) } } struct WaitBody { inner: wait::WaitStream<async_impl::Decoder> } impl Stream for WaitBody { type Item = <async_impl::Decoder as Stream>::Item; type Error = <async_impl::Decoder as Stream>::Error; fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> { match self.inner.next() { Some(Ok(chunk)) => Ok(Async::Ready(Some(chunk))), Some(Err(e)) => { let req_err = match e { wait::Waited::TimedOut => ::error::timedout(None), wait::Waited::Err(e) => e, }; Err(req_err) }, None => Ok(Async::Ready(None)), } } } impl<T: Into<async_impl::body::Body>> From<http::Response<T>> for Response { fn from(r: http::Response<T>) -> Response { let response = async_impl::Response::from(r); Response::new(response, None, KeepCoreThreadAlive::empty()) } }