rama_http/layer/map_response_body.rs
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
//! Apply a transformation to the response body.
//!
//! # Example
//!
//! ```
//! use bytes::Bytes;
//! use rama_http::{Body, Request, Response};
//! use rama_http::dep::http_body;
//! use std::convert::Infallible;
//! use std::{pin::Pin, task::{Context, Poll}};
//! use rama_core::{Layer, Service, context};
//! use rama_core::service::service_fn;
//! use rama_http::layer::map_response_body::MapResponseBodyLayer;
//! use rama_core::error::BoxError;
//! use futures_lite::ready;
//!
//! // A wrapper for a `http_body::Body` that prints the size of data chunks
//! pin_project_lite::pin_project! {
//! struct PrintChunkSizesBody<B> {
//! #[pin]
//! inner: B,
//! }
//! }
//!
//! impl<B> PrintChunkSizesBody<B> {
//! fn new(inner: B) -> Self {
//! Self { inner }
//! }
//! }
//!
//! impl<B> http_body::Body for PrintChunkSizesBody<B>
//! where B: http_body::Body<Data = Bytes, Error = BoxError>,
//! {
//! type Data = Bytes;
//! type Error = BoxError;
//!
//! fn poll_frame(
//! mut self: Pin<&mut Self>,
//! cx: &mut Context<'_>,
//! ) -> Poll<Option<Result<http_body::Frame<Self::Data>, Self::Error>>> {
//! let inner_body = self.as_mut().project().inner;
//! if let Some(frame) = ready!(inner_body.poll_frame(cx)?) {
//! if let Some(chunk) = frame.data_ref() {
//! println!("chunk size = {}", chunk.len());
//! } else {
//! eprintln!("no data chunk found");
//! }
//! Poll::Ready(Some(Ok(frame)))
//! } else {
//! Poll::Ready(None)
//! }
//! }
//!
//! fn is_end_stream(&self) -> bool {
//! self.inner.is_end_stream()
//! }
//!
//! fn size_hint(&self) -> http_body::SizeHint {
//! self.inner.size_hint()
//! }
//! }
//!
//! async fn handle(_: Request) -> Result<Response, Infallible> {
//! // ...
//! # Ok(Response::new(Body::default()))
//! }
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let mut svc = (
//! // Wrap response bodies in `PrintChunkSizesBody`
//! MapResponseBodyLayer::new(PrintChunkSizesBody::new),
//! ).layer(service_fn(handle));
//!
//! // Call the service
//! let request = Request::new(Body::from("foobar"));
//!
//! svc.serve(context::Context::default(), request).await?;
//! # Ok(())
//! # }
//! ```
use crate::{Request, Response};
use rama_core::{Context, Layer, Service};
use rama_utils::macros::define_inner_service_accessors;
use std::fmt;
/// Apply a transformation to the response body.
///
/// See the [module docs](crate::layer::map_response_body) for an example.
#[derive(Clone)]
pub struct MapResponseBodyLayer<F> {
f: F,
}
impl<F> MapResponseBodyLayer<F> {
/// Create a new [`MapResponseBodyLayer`].
///
/// `F` is expected to be a function that takes a body and returns another body.
pub const fn new(f: F) -> Self {
Self { f }
}
}
impl<S, F> Layer<S> for MapResponseBodyLayer<F>
where
F: Clone,
{
type Service = MapResponseBody<S, F>;
fn layer(&self, inner: S) -> Self::Service {
MapResponseBody::new(inner, self.f.clone())
}
}
impl<F> fmt::Debug for MapResponseBodyLayer<F> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("MapResponseBodyLayer")
.field("f", &std::any::type_name::<F>())
.finish()
}
}
/// Apply a transformation to the response body.
///
/// See the [module docs](crate::layer::map_response_body) for an example.
#[derive(Clone)]
pub struct MapResponseBody<S, F> {
inner: S,
f: F,
}
impl<S, F> MapResponseBody<S, F> {
/// Create a new [`MapResponseBody`].
///
/// `F` is expected to be a function that takes a body and returns another body.
pub const fn new(service: S, f: F) -> Self {
Self { inner: service, f }
}
define_inner_service_accessors!();
}
impl<F, S, State, ReqBody, ResBody, NewResBody> Service<State, Request<ReqBody>>
for MapResponseBody<S, F>
where
S: Service<State, Request<ReqBody>, Response = Response<ResBody>>,
State: Clone + Send + Sync + 'static,
ReqBody: Send + 'static,
ResBody: Send + Sync + 'static,
NewResBody: Send + Sync + 'static,
F: Fn(ResBody) -> NewResBody + Clone + Send + Sync + 'static,
{
type Response = Response<NewResBody>;
type Error = S::Error;
async fn serve(
&self,
ctx: Context<State>,
req: Request<ReqBody>,
) -> Result<Self::Response, Self::Error> {
let res = self.inner.serve(ctx, req).await?;
Ok(res.map(self.f.clone()))
}
}
impl<S, F> fmt::Debug for MapResponseBody<S, F>
where
S: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("MapResponseBody")
.field("inner", &self.inner)
.field("f", &std::any::type_name::<F>())
.finish()
}
}