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 565 566 567
use crate::{
metrics::Metrics,
redirect::EffectiveUri,
trailer::Trailer,
util::io::{copy_async, Sink},
};
use futures_io::{AsyncRead, AsyncWrite};
use http::{Response, Uri};
use std::{
fs::File,
io::{self, Read, Write},
net::SocketAddr,
path::Path,
};
/// Provides extension methods for working with HTTP responses.
pub trait ResponseExt<T> {
/// Get the trailer of the response containing headers that were received
/// after the response body.
///
/// See the documentation for [`Trailer`] for more details on how to handle
/// trailing headers.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// let mut response = isahc::get("https://my-site-with-trailers.com")?;
///
/// println!("Status: {}", response.status());
/// println!("Headers: {:#?}", response.headers());
///
/// // Read and discard the response body until the end.
/// response.consume()?;
///
/// // Now the trailer will be available as well.
/// println!("Trailing headers: {:#?}", response.trailer().try_get().unwrap());
/// # Ok::<(), isahc::Error>(())
/// ```
fn trailer(&self) -> &Trailer;
/// Get the effective URI of this response. This value differs from the
/// original URI provided when making the request if at least one redirect
/// was followed.
///
/// This information is only available if populated by the HTTP client that
/// produced the response.
fn effective_uri(&self) -> Option<&Uri>;
/// Get the local socket address of the last-used connection involved in
/// this request, if known.
///
/// Multiple connections may be involved in a request, such as with
/// redirects.
///
/// This method only makes sense with a normal Internet request. If some
/// other kind of transport is used to perform the request, such as a Unix
/// socket, then this method will return `None`.
fn local_addr(&self) -> Option<SocketAddr>;
/// Get the remote socket address of the last-used connection involved in
/// this request, if known.
///
/// Multiple connections may be involved in a request, such as with
/// redirects.
///
/// This method only makes sense with a normal Internet request. If some
/// other kind of transport is used to perform the request, such as a Unix
/// socket, then this method will return `None`.
///
/// # Addresses and proxies
///
/// The address returned by this method is the IP address and port that the
/// client _connected to_ and not necessarily the real address of the origin
/// server. Forward and reverse proxies between the caller and the server
/// can cause the address to be returned to reflect the address of the
/// nearest proxy rather than the server.
fn remote_addr(&self) -> Option<SocketAddr>;
/// Get the configured cookie jar used for persisting cookies from this
/// response, if any.
///
/// # Availability
///
/// This method is only available when the [`cookies`](index.html#cookies)
/// feature is enabled.
#[cfg(feature = "cookies")]
fn cookie_jar(&self) -> Option<&crate::cookies::CookieJar>;
/// If request metrics are enabled for this particular transfer, return a
/// metrics object containing a live view of currently available data.
///
/// By default metrics are disabled and `None` will be returned. To enable
/// metrics you can use
/// [`Configurable::metrics`](crate::config::Configurable::metrics).
fn metrics(&self) -> Option<&Metrics>;
}
impl<T> ResponseExt<T> for Response<T> {
#[allow(clippy::redundant_closure)]
fn trailer(&self) -> &Trailer {
// Return a static empty trailer if the extension does not exist. This
// offers a more convenient API so that users do not have to unwrap the
// trailer from an extra Option.
self.extensions().get().unwrap_or_else(|| Trailer::empty())
}
fn effective_uri(&self) -> Option<&Uri> {
self.extensions().get::<EffectiveUri>().map(|v| &v.0)
}
fn local_addr(&self) -> Option<SocketAddr> {
self.extensions().get::<LocalAddr>().map(|v| v.0)
}
fn remote_addr(&self) -> Option<SocketAddr> {
self.extensions().get::<RemoteAddr>().map(|v| v.0)
}
#[cfg(feature = "cookies")]
fn cookie_jar(&self) -> Option<&crate::cookies::CookieJar> {
self.extensions().get()
}
fn metrics(&self) -> Option<&Metrics> {
self.extensions().get()
}
}
/// Provides extension methods for consuming HTTP response streams.
pub trait ReadResponseExt<R: Read> {
/// Read any remaining bytes from the response body stream and discard them
/// until the end of the stream is reached. It is usually a good idea to
/// call this method before dropping a response if you know you haven't read
/// the entire response body.
///
/// # Background
///
/// By default, if a response stream is dropped before it has been
/// completely read from, then that HTTP connection will be terminated.
/// Depending on which version of HTTP is being used, this may require
/// closing the network connection to the server entirely. This can result
/// in sub-optimal performance for making multiple requests, as it prevents
/// Isahc from keeping the connection alive to be reused for subsequent
/// requests.
///
/// If you are downloading a file on behalf of a user and have been
/// requested to cancel the operation, then this is probably what you want.
/// But if you are making many small API calls to a known server, then you
/// may want to call `consume()` before dropping the response, as reading a
/// few megabytes off a socket is usually more efficient in the long run
/// than taking a hit on connection reuse, and opening new connections can
/// be expensive.
///
/// Note that in HTTP/2 and newer, it is not necessary to close the network
/// connection in order to interrupt the transfer of a particular response.
/// If you know that you will be using only HTTP/2 or newer, then calling
/// this method is probably unnecessary.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// let mut response = isahc::get("https://example.org")?;
///
/// println!("Status: {}", response.status());
/// println!("Headers: {:#?}", response.headers());
///
/// // Read and discard the response body until the end.
/// response.consume()?;
/// # Ok::<(), isahc::Error>(())
/// ```
fn consume(&mut self) -> io::Result<()> {
self.copy_to(io::sink())?;
Ok(())
}
/// Copy the response body into a writer.
///
/// Returns the number of bytes that were written.
///
/// # Examples
///
/// Copying the response into an in-memory buffer:
///
/// ```no_run
/// use isahc::prelude::*;
///
/// let mut buf = vec![];
/// isahc::get("https://example.org")?.copy_to(&mut buf)?;
/// println!("Read {} bytes", buf.len());
/// # Ok::<(), isahc::Error>(())
/// ```
fn copy_to<W: Write>(&mut self, writer: W) -> io::Result<u64>;
/// Write the response body to a file.
///
/// This method makes it convenient to download a file using a GET request
/// and write it to a file synchronously in a single chain of calls.
///
/// Returns the number of bytes that were written.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// isahc::get("https://httpbin.org/image/jpeg")?
/// .copy_to_file("myimage.jpg")?;
/// # Ok::<(), isahc::Error>(())
/// ```
fn copy_to_file<P: AsRef<Path>>(&mut self, path: P) -> io::Result<u64> {
File::create(path).and_then(|f| self.copy_to(f))
}
/// Read the entire response body into memory.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// let image_bytes = isahc::get("https://httpbin.org/image/jpeg")?.bytes()?;
/// # Ok::<(), isahc::Error>(())
/// ```
fn bytes(&mut self) -> io::Result<Vec<u8>>;
/// Read the response body as a string.
///
/// The encoding used to decode the response body into a string depends on
/// the response. If the body begins with a [Byte Order Mark
/// (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark), then UTF-8,
/// UTF-16LE or UTF-16BE is used as indicated by the BOM. If no BOM is
/// present, the encoding specified in the `charset` parameter of the
/// `Content-Type` header is used if present. Otherwise UTF-8 is assumed.
///
/// If the response body contains any malformed characters or characters not
/// representable in UTF-8, the offending bytes will be replaced with
/// `U+FFFD REPLACEMENT CHARACTER`, which looks like this: �.
///
/// This method consumes the entire response body stream and can only be
/// called once.
///
/// # Availability
///
/// This method is only available when the
/// [`text-decoding`](index.html#text-decoding) feature is enabled, which it
/// is by default.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// let text = isahc::get("https://example.org")?.text()?;
/// println!("{}", text);
/// # Ok::<(), isahc::Error>(())
/// ```
#[cfg(feature = "text-decoding")]
fn text(&mut self) -> io::Result<String>;
/// Deserialize the response body as JSON into a given type.
///
/// # Availability
///
/// This method is only available when the [`json`](index.html#json) feature
/// is enabled.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
/// use serde_json::Value;
///
/// let json: Value = isahc::get("https://httpbin.org/json")?.json()?;
/// println!("author: {}", json["slideshow"]["author"]);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[cfg(feature = "json")]
fn json<T>(&mut self) -> Result<T, serde_json::Error>
where
T: serde::de::DeserializeOwned;
}
impl<R: Read> ReadResponseExt<R> for Response<R> {
fn copy_to<W: Write>(&mut self, mut writer: W) -> io::Result<u64> {
io::copy(self.body_mut(), &mut writer)
}
fn bytes(&mut self) -> io::Result<Vec<u8>> {
let mut buf = allocate_buffer(self);
self.copy_to(&mut buf)?;
Ok(buf)
}
#[cfg(feature = "text-decoding")]
fn text(&mut self) -> io::Result<String> {
crate::text::Decoder::for_response(self).decode_reader(self.body_mut())
}
#[cfg(feature = "json")]
fn json<D>(&mut self) -> Result<D, serde_json::Error>
where
D: serde::de::DeserializeOwned,
{
serde_json::from_reader(self.body_mut())
}
}
/// Provides extension methods for consuming asynchronous HTTP response streams.
pub trait AsyncReadResponseExt<R: AsyncRead + Unpin> {
/// Read any remaining bytes from the response body stream and discard them
/// until the end of the stream is reached. It is usually a good idea to
/// call this method before dropping a response if you know you haven't read
/// the entire response body.
///
/// # Background
///
/// By default, if a response stream is dropped before it has been
/// completely read from, then that HTTP connection will be terminated.
/// Depending on which version of HTTP is being used, this may require
/// closing the network connection to the server entirely. This can result
/// in sub-optimal performance for making multiple requests, as it prevents
/// Isahc from keeping the connection alive to be reused for subsequent
/// requests.
///
/// If you are downloading a file on behalf of a user and have been
/// requested to cancel the operation, then this is probably what you want.
/// But if you are making many small API calls to a known server, then you
/// may want to call `consume()` before dropping the response, as reading a
/// few megabytes off a socket is usually more efficient in the long run
/// than taking a hit on connection reuse, and opening new connections can
/// be expensive.
///
/// Note that in HTTP/2 and newer, it is not necessary to close the network
/// connection in order to interrupt the transfer of a particular response.
/// If you know that you will be using only HTTP/2 or newer, then calling
/// this method is probably unnecessary.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// # async fn run() -> Result<(), isahc::Error> {
/// let mut response = isahc::get_async("https://example.org").await?;
///
/// println!("Status: {}", response.status());
/// println!("Headers: {:#?}", response.headers());
///
/// // Read and discard the response body until the end.
/// response.consume().await?;
/// # Ok(()) }
/// ```
fn consume(&mut self) -> ConsumeFuture<'_, R>;
/// Copy the response body into a writer asynchronously.
///
/// Returns the number of bytes that were written.
///
/// # Examples
///
/// Copying the response into an in-memory buffer:
///
/// ```no_run
/// use isahc::prelude::*;
///
/// # async fn run() -> Result<(), isahc::Error> {
/// let mut buf = vec![];
/// isahc::get_async("https://example.org").await?
/// .copy_to(&mut buf).await?;
/// println!("Read {} bytes", buf.len());
/// # Ok(()) }
/// ```
fn copy_to<'a, W>(&'a mut self, writer: W) -> CopyFuture<'a, R, W>
where
W: AsyncWrite + Unpin + 'a;
/// Read the entire response body into memory.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// # async fn run() -> Result<(), isahc::Error> {
/// let image_bytes = isahc::get_async("https://httpbin.org/image/jpeg")
/// .await?
/// .bytes()
/// .await?;
/// # Ok(()) }
/// ```
fn bytes(&mut self) -> BytesFuture<'_, &mut R>;
/// Read the response body as a string asynchronously.
///
/// This method consumes the entire response body stream and can only be
/// called once.
///
/// # Availability
///
/// This method is only available when the
/// [`text-decoding`](index.html#text-decoding) feature is enabled, which it
/// is by default.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
///
/// # async fn run() -> Result<(), isahc::Error> {
/// let text = isahc::get_async("https://example.org").await?
/// .text().await?;
/// println!("{}", text);
/// # Ok(()) }
/// ```
#[cfg(feature = "text-decoding")]
fn text(&mut self) -> crate::text::TextFuture<'_, &mut R>;
/// Deserialize the response body as JSON into a given type.
///
/// # Caveats
///
/// Unlike its [synchronous equivalent](ReadResponseExt::json), this method
/// reads the entire response body into memory before attempting
/// deserialization. This is due to a Serde limitation since incremental
/// partial deserializing is not supported.
///
/// # Availability
///
/// This method is only available when the [`json`](index.html#json) feature
/// is enabled.
///
/// # Examples
///
/// ```no_run
/// use isahc::prelude::*;
/// use serde_json::Value;
///
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// let json: Value = isahc::get_async("https://httpbin.org/json").await?
/// .json().await?;
/// println!("author: {}", json["slideshow"]["author"]);
/// # Ok(()) }
/// ```
#[cfg(feature = "json")]
fn json<T>(&mut self) -> JsonFuture<'_, R, T>
where
T: serde::de::DeserializeOwned;
}
impl<R: AsyncRead + Unpin> AsyncReadResponseExt<R> for Response<R> {
fn consume(&mut self) -> ConsumeFuture<'_, R> {
ConsumeFuture::new(async move {
copy_async(self.body_mut(), Sink).await?;
Ok(())
})
}
fn copy_to<'a, W>(&'a mut self, writer: W) -> CopyFuture<'a, R, W>
where
W: AsyncWrite + Unpin + 'a,
{
CopyFuture::new(async move { copy_async(self.body_mut(), writer).await })
}
fn bytes(&mut self) -> BytesFuture<'_, &mut R> {
BytesFuture::new(async move {
let mut buf = allocate_buffer(self);
copy_async(self.body_mut(), &mut buf).await?;
Ok(buf)
})
}
#[cfg(feature = "text-decoding")]
fn text(&mut self) -> crate::text::TextFuture<'_, &mut R> {
crate::text::Decoder::for_response(self).decode_reader_async(self.body_mut())
}
#[cfg(feature = "json")]
fn json<T>(&mut self) -> JsonFuture<'_, R, T>
where
T: serde::de::DeserializeOwned,
{
JsonFuture::new(async move {
let mut buf = allocate_buffer(self);
// Serde does not support incremental parsing, so we have to resort
// to reading the entire response into memory first and then
// deserializing.
if let Err(e) = copy_async(self.body_mut(), &mut buf).await {
struct ErrorReader(Option<io::Error>);
impl Read for ErrorReader {
fn read(&mut self, _buf: &mut [u8]) -> io::Result<usize> {
Err(self.0.take().unwrap())
}
}
// Serde offers no public way to directly create an error from
// an I/O error, but we can do so in a roundabout way by parsing
// a reader that always returns the desired error.
serde_json::from_reader(ErrorReader(Some(e)))
} else {
serde_json::from_slice(&buf)
}
})
}
}
fn allocate_buffer<T>(response: &Response<T>) -> Vec<u8> {
if let Some(length) = get_content_length(response) {
Vec::with_capacity(length as usize)
} else {
Vec::new()
}
}
fn get_content_length<T>(response: &Response<T>) -> Option<u64> {
response
.headers()
.get(http::header::CONTENT_LENGTH)?
.to_str()
.ok()?
.parse()
.ok()
}
decl_future! {
/// A future which reads any remaining bytes from the response body stream
/// and discard them.
pub type ConsumeFuture<R> = impl Future<Output = io::Result<()>> + SendIf<R>;
/// A future which copies all the response body bytes into a sink.
pub type CopyFuture<R, W> = impl Future<Output = io::Result<u64>> + SendIf<R, W>;
/// A future which reads the entire response body into memory.
pub type BytesFuture<R> = impl Future<Output = io::Result<Vec<u8>>> + SendIf<R>;
/// A future which deserializes the response body as JSON.
#[cfg(feature = "json")]
pub type JsonFuture<R, T> = impl Future<Output = Result<T, serde_json::Error>> + SendIf<R, T>;
}
pub(crate) struct LocalAddr(pub(crate) SocketAddr);
pub(crate) struct RemoteAddr(pub(crate) SocketAddr);
#[cfg(test)]
mod tests {
use super::*;
static_assertions::assert_impl_all!(CopyFuture<'static, Vec<u8>, Vec<u8>>: Send);
// *mut T is !Send
static_assertions::assert_not_impl_any!(CopyFuture<'static, *mut Vec<u8>, Vec<u8>>: Send);
static_assertions::assert_not_impl_any!(CopyFuture<'static, Vec<u8>, *mut Vec<u8>>: Send);
static_assertions::assert_not_impl_any!(CopyFuture<'static, *mut Vec<u8>, *mut Vec<u8>>: Send);
}