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
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

use super::chain::Mid;
use super::path::ParsedPath;
use super::router::RouteMethod;
use super::Handler;
use super::Router;
use super::StateHandler;
use super::{Middleware, StateMiddleware};
use http::Method;
use std::fmt;
use std::sync::Arc;

/// A route as obtained by [`Server::at`] or [`Router::at`].
///
/// [`Server::at`]: struct.Server.html#method.at
/// [`Router::at`]: struct.Router.html#method.at
pub struct Route<'a, State> {
    router: &'a mut Router<State>,
    path: ParsedPath,
    middlewares: Vec<Arc<Mid<State>>>,
}

impl<'a, State> Route<'a, State>
where
    State: Clone + Unpin + Send + Sync + 'static,
{
    pub(crate) fn new(router: &'a mut Router<State>, path: ParsedPath) -> Self {
        Route {
            router,
            path,
            middlewares: vec![],
        }
    }

    /// Attach [`Middleware`].
    ///
    /// Middleware must be added before handlers that are to be affected by it.
    ///
    /// [`Middleware`]: trait.Middleware.html
    pub fn middleware<M: Middleware>(mut self, middleware: M) -> Self {
        let boxed: Box<dyn Middleware> = Box::new(middleware);
        self.middlewares.push(Arc::new(boxed.into()));
        self
    }

    /// Attach a [`Router`].
    ///
    /// [`Router`]: struct.Router.html
    pub fn router(self, mut router: Router<State>) -> Self {
        let m = RouteMethod::All;
        let mw = self.middlewares.clone();
        router.set_prefix(self.path.path());
        self.router.add_handler(m, &self.path, mw, router.into());
        self
    }

    /// Continue using stateful middleware and handlers.
    ///
    /// # Example
    ///
    /// ```
    /// use hreq::prelude::*;
    /// use std::sync::{Arc, Mutex};
    ///
    /// #[derive(Clone)]
    /// struct MyState(Arc<Mutex<String>>);
    ///
    /// async fn start_server() {
    ///     let state = MyState(Arc::new(Mutex::new("Hello".to_string())));
    ///     let mut server = Server::with_state(state);
    ///     server.at("/stateful").with_state().get(get_thing);
    /// }
    ///
    /// async fn get_thing(state: MyState, req: http::Request<Body>) -> String {
    ///     format!("Hello {}", req.path_param("name").unwrap())
    /// }
    /// ```
    pub fn with_state(self) -> StateRoute<'a, State> {
        StateRoute(self)
    }
}

impl<'a, State> Route<'a, State>
where
    State: Clone + Unpin + Send + Sync + 'static,
{
    /// Attach a handler for the given method.
    pub fn method<H: Handler>(self, method: Method, handler: H) -> Self {
        let m = RouteMethod::Method(method);
        let mw = self.middlewares.clone();
        let boxed: Box<dyn Handler> = Box::new(handler);
        self.router.add_handler(m, &self.path, mw, boxed.into());
        self
    }

    /// Attach a handler for all methods.
    pub fn all<H: Handler>(self, handler: H) -> Self {
        let m = RouteMethod::All;
        let mw = self.middlewares.clone();
        let boxed: Box<dyn Handler> = Box::new(handler);
        self.router.add_handler(m, &self.path, mw, boxed.into());
        self
    }

    /// GET request handler.
    pub fn get<H: Handler>(self, handler: H) -> Self {
        self.method(Method::GET, handler)
    }

    /// HEAD request handler.
    pub fn head<H: Handler>(self, handler: H) -> Self {
        self.method(Method::HEAD, handler)
    }

    /// POST request handler.
    pub fn post<H: Handler>(self, handler: H) -> Self {
        self.method(Method::POST, handler)
    }

    /// PUT request handler.
    pub fn put<H: Handler>(self, handler: H) -> Self {
        self.method(Method::PUT, handler)
    }

    /// DELETE request handler.
    pub fn delete<H: Handler>(self, handler: H) -> Self {
        self.method(Method::DELETE, handler)
    }

    /// OPTIONS request handler.
    pub fn options<H: Handler>(self, handler: H) -> Self {
        self.method(Method::OPTIONS, handler)
    }

    /// CONNECT request handler.
    pub fn connect<H: Handler>(self, handler: H) -> Self {
        self.method(Method::CONNECT, handler)
    }

    /// PATCH request handler.
    pub fn patch<H: Handler>(self, handler: H) -> Self {
        self.method(Method::PATCH, handler)
    }

    /// TRACE request handler.
    pub fn trace<H: Handler>(self, handler: H) -> Self {
        self.method(Method::TRACE, handler)
    }
}

/// A state route as obtained by [`with_state`].
///
/// ```
/// use hreq::prelude::*;
/// use std::sync::{Arc, Mutex};
///
/// #[derive(Clone)]
/// struct MyState(Arc<Mutex<String>>);
///
/// async fn start_server() {
///     let state = MyState(Arc::new(Mutex::new("Hello".to_string())));
///     let mut server = Server::with_state(state);
///     server.at("/stateful").with_state().get(get_thing);
/// }
///
/// async fn get_thing(state: MyState, req: http::Request<Body>) -> String {
///     format!("Hello {}", req.path_param("name").unwrap())
/// }
/// ```
///
/// [`Server::at`]: struct.Server.html#method.at
/// [`Router::at`]: struct.Router.html#method.at
/// [`with_state`]: struct.Route.html#method.with_state
pub struct StateRoute<'a, State>(Route<'a, State>);

impl<'a, State> StateRoute<'a, State>
where
    State: Clone + Unpin + Send + Sync + 'static,
{
    /// Attach [`Middleware`].
    ///
    /// Middleware must be added before handlers that are to be affected by it.
    ///
    /// [`Middleware`]: trait.Middleware.html
    pub fn middleware<M: StateMiddleware<State>>(mut self, middleware: M) -> Self {
        let boxed: Box<dyn StateMiddleware<State>> = Box::new(middleware);
        self.0.middlewares.push(Arc::new(boxed.into()));
        self
    }

    /// Attach a [`Router`].
    ///
    /// [`Router`]: struct.Router.html
    pub fn router(self, mut router: Router<State>) {
        let m = RouteMethod::All;
        let mw = self.0.middlewares.clone();
        router.set_prefix(self.0.path.path());
        self.0
            .router
            .add_handler(m, &self.0.path, mw, router.into());
    }
}

impl<'a, State> StateRoute<'a, State>
where
    State: Clone + Unpin + Send + Sync + 'static,
{
    /// Attach a handler for the given method.
    pub fn method<H: StateHandler<State>>(self, method: Method, handler: H) -> Self {
        let m = RouteMethod::Method(method);
        let mw = self.0.middlewares.clone();
        let boxed: Box<dyn StateHandler<State>> = Box::new(handler);
        self.0.router.add_handler(m, &self.0.path, mw, boxed.into());
        self
    }

    /// Attach a handler for all methods.
    pub fn all<H: StateHandler<State>>(self, handler: H) -> Self {
        let m = RouteMethod::All;
        let mw = self.0.middlewares.clone();
        let boxed: Box<dyn StateHandler<State>> = Box::new(handler);
        self.0.router.add_handler(m, &self.0.path, mw, boxed.into());
        self
    }

    /// GET request handler.
    pub fn get<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::GET, handler)
    }

    /// HEAD request handler.
    pub fn head<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::HEAD, handler)
    }

    /// POST request handler.
    pub fn post<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::POST, handler)
    }

    /// PUT request handler.
    pub fn put<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::PUT, handler)
    }

    /// DELETE request handler.
    pub fn delete<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::DELETE, handler)
    }

    /// OPTIONS request handler.
    pub fn options<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::OPTIONS, handler)
    }

    /// CONNECT request handler.
    pub fn connect<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::CONNECT, handler)
    }

    /// PATCH request handler.
    pub fn patch<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::PATCH, handler)
    }

    /// TRACE request handler.
    pub fn trace<H: StateHandler<State>>(self, handler: H) -> Self {
        self.method(Method::TRACE, handler)
    }
}

impl<'a, State> fmt::Debug for Route<'a, State> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Route")
    }
}

impl<'a, State> fmt::Debug for StateRoute<'a, State> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "StateRoute")
    }
}