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

use super::chain::{Chain, End, Mid, MidWrap};
use super::path::ParsedPath;
use super::Reply;
use super::Route;
use crate::Body;
use http::Request;
use http::Response;
use std::fmt;
use std::future::Future;
use std::sync::Arc;

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum RouteMethod {
    All,
    Method(http::Method),
}

impl PartialEq<http::Method> for RouteMethod {
    fn eq(&self, other: &http::Method) -> bool {
        match self {
            RouteMethod::All => true,
            RouteMethod::Method(m) => m == other,
        }
    }
}

/// Encapsulate chains of [`Middleware`] and [`Handler`].
///
/// Inside [`Server`] there is always a default router which is configured
/// via [`Server::at`], however routers can also be instantiated and configured
/// separately. This can be a good strategy for complex servers with many
/// subsystems.
///
/// # Example
///
///  ```
///  use hreq::prelude::*;
///
///  async fn start_server() {
///     let mut server = Server::new();
///
///     let mut router = Router::new();
///     router.at("/hello/:name").get(hello_there);
///
///     // Resulting route is /much/hello/<name>
///     server.at("/much").router(router);
///
///     server.listen(3000).await.unwrap();
///  }
///
///  async fn hello_there(req: http::Request<Body>) -> String {
///     format!("Hello {}", req.path_param("name").unwrap())
///  }
///  ```
///
/// [`Middleware`]: trait.Middleware.html
/// [`Handler`]: trait.Handler.html
/// [`Server`]: struct.Server.html
/// [`Server::at`]: struct.Server.html#method.at
#[derive(Clone)]
pub struct Router<State> {
    prefix: String,
    endpoints: Vec<Endpoint<State>>,
}

impl<State> Router<State>
where
    State: Clone + Unpin + Send + Sync + 'static,
{
    /// Creates a new router.
    pub fn new() -> Router<State> {
        Router {
            prefix: "".into(),
            endpoints: vec![],
        }
    }

    /// Routers added as routes receives the prefix they are "mounted" under.
    pub(crate) fn set_prefix(&mut self, prefix: &str) {
        self.prefix = prefix.into();
    }

    /// Configure an route for this server.
    ///
    /// A route is a chain of zero or more [`Middleware`]
    /// followed by a [`Handler`].
    ///
    /// Reusing the same `path` will overwrite the previous config.
    ///
    /// [`Middleware`]: trait.Middleware.html
    /// [`Handler`]: trait.Handler.html
    pub fn at(&mut self, path: &str) -> Route<'_, State> {
        let path = ParsedPath::parse(path);
        self.reset(&path);
        Route::new(self, path)
    }

    pub(crate) fn reset(&mut self, path: &ParsedPath) {
        self.endpoints.retain(|r| !r.is_path(path));
    }

    pub(crate) fn add_handler(
        &mut self,
        method: RouteMethod,
        path: &ParsedPath,
        mw: Vec<Arc<Mid<State>>>,
        end: End<State>,
    ) {
        let mut chain: Chain<State> = end.into();
        for mid in mw.into_iter().rev() {
            chain = MidWrap::wrap(mid, chain).into();
        }
        self.endpoints.push(Endpoint::new(method, path, chain));
    }

    pub(crate) fn run<'a>(
        &'a self,
        state: Arc<State>,
        mut req: Request<Body>,
    ) -> impl Future<Output = Reply> + Send + 'a {
        let uri = req.uri();
        let full_path = uri.path();

        assert!(full_path.starts_with(&self.prefix));
        let path = full_path.replacen(&self.prefix, "", 1);

        async move {
            for ep in &self.endpoints {
                if &ep.method != req.method() {
                    continue;
                }
                let m = ep.path.path_match(&path);
                if let Some(m) = m {
                    trace!("Use endpoint: {:?}", ep);
                    req.extensions_mut().insert(m);
                    return ep.chain.run(state, req).await;
                }
            }
            trace!("No endpoint");
            Response::builder().status(404).body("Not found").into()
        }
    }
}

#[derive(Clone)]
struct Endpoint<State> {
    method: RouteMethod,
    path: ParsedPath,
    chain: Chain<State>,
}

impl<State> Endpoint<State> {
    fn new(method: RouteMethod, path: &ParsedPath, chain: Chain<State>) -> Self {
        Endpoint {
            method,
            path: path.clone(),
            chain,
        }
    }

    fn is_path(&self, path: &ParsedPath) -> bool {
        &self.path == path
    }
}

impl<State> fmt::Debug for Endpoint<State> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "Endpoint {{ method: {:?}, path: {:?}, chain: {:?} }}",
            self.method, self.path, self.chain
        )
    }
}

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