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
//! Middleware that decompresses response bodies.
//!
//! # Example
//!
//! ```rust
//! use bytes::BytesMut;
//! use http::{Request, Response};
//! use http_body::Body as _; // for Body::data
//! use hyper::Body;
//! use std::convert::Infallible;
//! use tower::{Service, ServiceExt, ServiceBuilder, service_fn};
//! use tower_http::{compression::Compression, decompression::DecompressionLayer, BoxError};
//! #
//! # #[tokio::main]
//! # async fn main() -> Result<(), tower_http::BoxError> {
//! # async fn handle(req: Request<Body>) -> Result<Response<Body>, Infallible> {
//! # let body = Body::from("Hello, World!");
//! # Ok(Response::new(body))
//! # }
//!
//! // Some opaque service that applies compression.
//! let service = Compression::new(service_fn(handle));
//!
//! // Our HTTP client.
//! let mut client = ServiceBuilder::new()
//! // Automatically decompress response bodies.
//! .layer(DecompressionLayer::new())
//! .service(service);
//!
//! // Call the service.
//! //
//! // `DecompressionLayer` takes care of setting `Accept-Encoding`.
//! let request = Request::new(Body::empty());
//!
//! let response = client
//! .ready()
//! .await?
//! .call(request)
//! .await?;
//!
//! // Read the body
//! let mut body = response.into_body();
//! let mut bytes = BytesMut::new();
//! while let Some(chunk) = body.data().await {
//! let chunk = chunk?;
//! bytes.extend_from_slice(&chunk[..]);
//! }
//! let body = String::from_utf8(bytes.to_vec()).map_err(Into::<BoxError>::into)?;
//!
//! assert_eq!(body, "Hello, World!");
//! #
//! # Ok(())
//! # }
//! ```
mod body;
mod future;
mod layer;
mod service;
pub use self::{
body::DecompressionBody, future::ResponseFuture, layer::DecompressionLayer,
service::Decompression,
};
#[cfg(test)]
mod tests {
use super::*;
use crate::compression::Compression;
use bytes::BytesMut;
use http::Response;
use http_body::Body as _;
use hyper::{Body, Client, Error, Request};
use tower::{service_fn, Service, ServiceExt};
#[tokio::test]
async fn works() {
let mut client = Decompression::new(Compression::new(service_fn(handle)));
let req = Request::builder()
.header("accept-encoding", "gzip")
.body(Body::empty())
.unwrap();
let res = client.ready().await.unwrap().call(req).await.unwrap();
// read the body, it will be decompressed automatically
let mut body = res.into_body();
let mut data = BytesMut::new();
while let Some(chunk) = body.data().await {
let chunk = chunk.unwrap();
data.extend_from_slice(&chunk[..]);
}
let decompressed_data = String::from_utf8(data.freeze().to_vec()).unwrap();
assert_eq!(decompressed_data, "Hello, World!");
}
async fn handle(_req: Request<Body>) -> Result<Response<Body>, Error> {
Ok(Response::new(Body::from("Hello, World!")))
}
#[allow(dead_code)]
async fn is_compatible_with_hyper() {
let mut client = Decompression::new(Client::new());
let req = Request::new(Body::empty());
let _: Response<DecompressionBody<Body>> =
client.ready().await.unwrap().call(req).await.unwrap();
}
}