rama-http 0.3.0-rc1

rama http layers, services and other utilities
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

//! Apply a transformation to the request body.
//!
//! # Example
//!
//! ```
//! use rama_http::{Body, Request, Response, StreamingBody, body::{Frame, SizeHint}};
//! use rama_core::bytes::Bytes;
//! use std::convert::Infallible;
//! use std::{pin::Pin, task::{ready, Context, Poll}};
//! use rama_core::{Layer, Service};
//! use rama_core::service::service_fn;
//! use rama_http::layer::map_request_body::MapRequestBodyLayer;
//! use rama_core::error::BoxError;
//!
//! // A wrapper for a `Full<Bytes>`
//! struct BodyWrapper {
//!     inner: Body,
//! }
//!
//! impl BodyWrapper {
//!     fn new(inner: Body) -> Self {
//!         Self { inner }
//!     }
//! }
//!
//! impl StreamingBody for BodyWrapper {
//!     // ...
//!     # type Data = Bytes;
//!     # type Error = BoxError;
//!     # fn poll_frame(
//!     #     self: Pin<&mut Self>,
//!     #     cx: &mut Context<'_>
//!     # ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>> { unimplemented!() }
//!     # fn is_end_stream(&self) -> bool { unimplemented!() }
//!     # fn size_hint(&self) -> SizeHint { unimplemented!() }
//! }
//!
//! async fn handle<B>(_: Request<B>) -> 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 `BodyWrapper`
//!     MapRequestBodyLayer::new(BodyWrapper::new),
//! ).into_layer(service_fn(handle));
//!
//! // Call the service
//! let request = Request::new(Body::default());
//!
//! svc.serve(request).await?;
//! # Ok(())
//! # }
//! ```

use crate::{Request, Response};
use rama_core::{Layer, Service, bytes::Bytes, error::BoxError};
use rama_http_types::StreamingBody;
use rama_utils::macros::define_inner_service_accessors;
use std::fmt;

/// Apply a transformation to the request body.
///
/// See the [module docs](crate::layer::map_request_body) for an example.
#[derive(Clone)]
pub struct MapRequestBodyLayer<F> {
    f: F,
}

impl<F> MapRequestBodyLayer<F> {
    /// Create a new [`MapRequestBodyLayer`].
    ///
    /// `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<Body> MapRequestBodyLayer<fn(Body) -> crate::Body>
where
    Body: StreamingBody<Data = Bytes, Error: Into<BoxError>> + Send + Sync + 'static,
{
    /// Turn the [`StreamingBody`] into a [`crate::Body`] using [`crate::Body::new`].
    ///
    /// This is shorthand for `MapRequestBodyLayer::new(Body::new)`.
    pub const fn new_boxed_streaming_body() -> Self {
        Self::new(crate::Body::new)
    }
}

impl<Body> MapRequestBodyLayer<fn(Body) -> crate::Body>
where
    crate::Body: From<Body>,
{
    /// Turn the body into a [`crate::Body`] using [`crate::Body::from`].
    ///
    /// This is shorthand for `MapRequestBodyLayer::new(Body::from)`.
    pub const fn into_boxed_streaming_body() -> Self {
        Self::new(crate::Body::from)
    }
}

impl<S, F> Layer<S> for MapRequestBodyLayer<F>
where
    F: Clone,
{
    type Service = MapRequestBody<S, F>;

    fn layer(&self, inner: S) -> Self::Service {
        MapRequestBody::new(inner, self.f.clone())
    }

    fn into_layer(self, inner: S) -> Self::Service {
        MapRequestBody::new(inner, self.f)
    }
}

impl<F> fmt::Debug for MapRequestBodyLayer<F> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("MapRequestBodyLayer")
            .field("f", &std::any::type_name::<F>())
            .finish()
    }
}

/// Apply a transformation to the request body.
///
/// See the [module docs](crate::layer::map_request_body) for an example.
#[derive(Clone)]
pub struct MapRequestBody<S, F> {
    inner: S,
    f: F,
}

impl<S, F> MapRequestBody<S, F> {
    /// Create a new [`MapRequestBody`].
    ///
    /// `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<S, Body> MapRequestBody<S, fn(Body) -> crate::Body>
where
    Body: StreamingBody<Data = Bytes, Error: Into<BoxError>> + Send + Sync + 'static,
{
    /// Turn the [`StreamingBody`] into a [`crate::Body`] using [`crate::Body::new`].
    ///
    /// This is shorthand for `MapRequestBody::new(..., Body::new)`.
    pub const fn new_boxed_streaming_body(inner: S) -> Self {
        Self::new(inner, crate::Body::new)
    }
}

impl<S, Body> MapRequestBody<S, fn(Body) -> crate::Body>
where
    crate::Body: From<Body>,
{
    /// Turn the body into a [`crate::Body`] using [`crate::Body::from`].
    ///
    /// This is shorthand for `MapRequestBody::new(..., Body::from)`.
    pub const fn into_boxed_streaming_body(inner: S) -> Self {
        Self::new(inner, crate::Body::from)
    }
}

impl<F, S, ReqBody, ResBody, NewReqBody> Service<Request<ReqBody>> for MapRequestBody<S, F>
where
    S: Service<Request<NewReqBody>, Output = Response<ResBody>>,
    ReqBody: Send + 'static,
    NewReqBody: Send + 'static,
    ResBody: Send + Sync + 'static,
    F: Fn(ReqBody) -> NewReqBody + Send + Sync + 'static,
{
    type Output = S::Output;
    type Error = S::Error;

    async fn serve(&self, req: Request<ReqBody>) -> Result<Self::Output, Self::Error> {
        let req = req.map(&self.f);
        self.inner.serve(req).await
    }
}

impl<S, F> fmt::Debug for MapRequestBody<S, F>
where
    S: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("MapRequestBody")
            .field("inner", &self.inner)
            .field("f", &std::any::type_name::<F>())
            .finish()
    }
}