hreq 0.8.0

hreq is a user first async http client
Documentation 
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

use super::Next;
use super::Reply;
use crate::Body;
use http::Request;
use std::future::Future;
use std::pin::Pin;

/// Trait for middleware that doesn't use a state.
///
/// Typically this trait is not used directly since there is a blanket implementation
/// for any function that matches this signature:
///
/// ```ignore
/// async fn my_middleware(req: Request<Body>, next: Next) -> impl Into<Reply> {
///    ...
/// }
/// ```
///
/// [`Reply`] is not a type you would use in your own type signatures. `impl Into<Reply>`
/// represents a whole range of (concrete) possible return types. See [`Reply`] for more details.
///
/// # Examples
///
/// ```
/// use hreq::Error;
/// use hreq::prelude::*;
/// use hreq::server::Next;
///
/// fn main() {
///     let mut server = Server::new();
///
///     server.at("/path")
///         .middleware(my_middle)
///         .get(|_req| async { "Hello" });
/// }
///
/// async fn my_middle(
///     req: Request<Body>,
///     next: Next,
/// ) -> Result<Response<Body>, Error> {
///
///     // Do things with request here.
///
///     // Continue the request chain.
///     let res = next.run(req).await?;
///
///     // Do things with the response here.
///
///     Ok(res)
/// }
/// ```
///
///  [`Reply`]: struct.Reply.html
pub trait Middleware: Send + Sync + 'static {
    /// Call the middleware.
    fn call<'a>(
        &'a self,
        req: Request<Body>,
        next: Next,
    ) -> Pin<Box<dyn Future<Output = Reply> + Send + 'a>>;
}

impl<F: Send + Sync + 'static, Fut, Ret> Middleware for F
where
    F: Fn(Request<Body>, Next) -> Fut,
    Fut: Future<Output = Ret> + Send + 'static,
    Ret: Into<Reply>,
{
    fn call<'a>(
        &'a self,
        req: Request<Body>,
        next: Next,
    ) -> Pin<Box<dyn Future<Output = Reply> + Send + 'a>> {
        let fut = (self)(req, next);
        Box::pin(async move { fut.await.into() })
    }
}

/// Trait for middleware that use a state.
///
/// Typically this trait is not used directly since there is a blanket implementation
/// for any function that matches this signature:
///
/// ```ignore
/// async fn my_middleware(
///     state: MyState,
///     req: Request<Body>,
///     next: Next
/// ) -> impl Into<Reply> {
///    ...
/// }
/// ```
///
/// [`Reply`] is not a type you would use in your own type signatures. `impl Into<Reply>`
/// represents a whole range of (concrete) possible return types. See [`Reply`] for more details.
///
/// # Examples
///
/// ```
/// use hreq::Error;
/// use hreq::prelude::*;
/// use hreq::server::Next;
/// use std::sync::{Arc, Mutex};
///
/// #[derive(Clone)]
/// struct MyState(Arc<Mutex<String>>);
///
/// fn main() {
///    let state = MyState(Arc::new(Mutex::new("Hello".to_string())));
///    let mut server = Server::with_state(state);
///
///    server.at("/path")
///        .with_state()
///        .middleware(my_middle)
///        .get(|state, req| async { "Hello" });
/// }
///
/// async fn my_middle(
///     state: MyState,
///     req: Request<Body>,
///     next: Next,
/// ) -> Result<Response<Body>, Error> {
///
///     // Do things with request here.
///
///     // Continue the request chain.
///     let res = next.run(req).await?;
///
///     // Do things with the response here.
///
///     Ok(res)
/// }
/// ```
///
///  [`Reply`]: struct.Reply.html
pub trait StateMiddleware<State>: Send + Sync + 'static {
    /// Call the middleware.
    fn call<'a>(
        &'a self,
        state: State,
        req: Request<Body>,
        next: Next,
    ) -> Pin<Box<dyn Future<Output = Reply> + Send + 'a>>;
}

impl<State, F: Send + Sync + 'static, Fut, Ret> StateMiddleware<State> for F
where
    F: Fn(State, Request<Body>, Next) -> Fut,
    Fut: Future<Output = Ret> + Send + 'static,
    Ret: Into<Reply>,
{
    fn call<'a>(
        &'a self,
        state: State,
        req: Request<Body>,
        next: Next,
    ) -> Pin<Box<dyn Future<Output = Reply> + Send + 'a>> {
        let fut = (self)(state, req, next);
        Box::pin(async move { fut.await.into() })
    }
}