tackt 0.1.2

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

use std::future::Future;

use tower_service::Service;

use crate::error::Error;
use crate::func::Func;
use crate::mount::Mount;
use crate::or::Or;
use crate::param::Param;
use crate::request::PathReq;
use crate::request::RemovePrefix;
use crate::route::Route;
use crate::void::Void;
use crate::with::With;

/// The router instance.
///
/// Note that a router does not implement Route. It only implement service.
#[derive(Clone, Copy, Debug)]
pub struct Router<R> {
    inner: R,
}

impl<R, T> Service<T> for Router<R>
where
    R: Service<T>,
{
    type Response = R::Response;

    type Error = R::Error;

    type Future = R::Future;

    fn poll_ready(
        &mut self,
        _: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Result<(), Self::Error>> {
        std::task::Poll::Ready(Ok(()))
    }

    fn call(&mut self, req: T) -> Self::Future {
        self.inner.call(req)
    }
}

impl<T, U> Router<Void<T, U>> {
    /// Create a router that does not match any request.
    pub const fn void() -> Router<Void<T, U>> {
        Router { inner: Void::new() }
    }
}

impl<F, P> Router<Func<F, P>> {
    /// Create a new router with the route.
    #[inline]
    pub fn new<T, U, E, Fut>(route: F) -> Router<Func<F, P>>
    where
        F: FnMut(T, P) -> Fut,
        P: Param<T>,
        E: From<Error>,
        Fut: Future<Output = Result<U, E>>,
    {
        Router {
            inner: Func::new(route),
        }
    }
}

impl<R> Router<R> {
    /// Add new route to this router.
    #[inline]
    pub fn route<F, T, P, U, E, Fut>(self, route: F) -> Router<Or<R, Func<F, P>>>
    where
        R: Route<T, Response = U, Error = E>,
        F: FnMut(T, P) -> Fut,
        P: Param<T>,
        E: From<Error>,
        Fut: Future<Output = Result<U, E>>,
    {
        Router {
            inner: Or::new(self.inner, Func::new(route)),
        }
    }

    /// Mount a service at prefix.
    ///
    /// Any request to prefix will be delegated to the service with the prefix
    /// stripped.
    ///
    /// *NOTE*: `prefix` will be stripped from any trailing slash.
    ///
    /// # Panic
    ///
    /// Panic if one of these conditions is met:
    ///
    /// 1. Prefix contains `?`.
    /// 2. Prefix contains `#`.
    /// 3. Prefix is empty.
    /// 4. Prefix is `/`.
    /// 5. Prefix does not start with `/`.
    #[inline]
    pub fn mount<S, T, U, E>(self, prefix: &'static str, service: S) -> Router<Or<R, Mount<S>>>
    where
        R: Route<T, Response = U, Error = E>,
        S: Service<T, Response = U, Error = E>,
        T: PathReq + RemovePrefix,
        E: From<Error>,
    {
        let prefix = prefix.trim_end_matches('/');
        assert!(!prefix.contains('?'), "Prefix cannot contains '?'");
        assert!(!prefix.contains('#'), "Prefix cannot contains '#'");
        assert!(!prefix.is_empty(), "Prefix cannot be empty");
        assert!(prefix != "/", "Prefix cannot be '/'");
        assert!(prefix.starts_with('/'), "Prefix must be starts with '/'");
        Router {
            inner: Or::new(self.inner, Mount::new(service, prefix)),
        }
    }

    /// Add middleware to the router.
    #[inline]
    pub fn with<F, T, Fut>(self, func: F) -> Router<With<R, F>>
    where
        R: Clone + Service<T>,
        F: FnMut(T) -> Fut,
        Fut: Future<Output = Result<T, R::Error>>,
    {
        Router {
            inner: With::new(self.inner, func),
        }
    }
}

#[cfg(test)]
mod tests {
    use std::convert::Infallible;
    use std::net::SocketAddr;

    use http::Request;
    use http::Response;
    use hyper::service::make_service_fn;
    use hyper::Body;

    use crate::error::Error;
    use crate::param::Param;
    use crate::Router;

    #[derive(Clone, Copy, Debug)]
    struct Home;

    impl Param<Request<Body>> for Home {
        fn from_request(req: &Request<Body>) -> Result<Self, Error> {
            match req.uri().path() {
                "/" => Ok(Home),
                _ => Err(Error::Path),
            }
        }
    }

    async fn home(req: Request<Body>, param: Home) -> Result<Response<Body>, Error> {
        Ok(Response::new(Body::from(format!(
            "{:?} @ {}",
            param,
            req.uri().path()
        ))))
    }

    #[derive(Clone, Copy, Debug)]
    struct About;

    impl Param<Request<Body>> for About {
        fn from_request(req: &Request<Body>) -> Result<Self, Error> {
            match req.uri().path() {
                "/about" => Ok(About),
                _ => Err(Error::Path),
            }
        }
    }

    async fn about(req: Request<Body>, param: About) -> Result<Response<Body>, Error> {
        Ok(Response::new(Body::from(format!(
            "{:?} @ {}",
            param,
            req.uri().path()
        ))))
    }

    #[test]
    #[allow(dead_code)]
    fn compile() {
        let subrouter = Router::new(home).route(about);
        let router = Router::new(home).route(about).mount("/sub", subrouter);

        let _ = |addr: SocketAddr| async move {
            let _ = hyper::server::Server::bind(&addr)
                .serve(make_service_fn(
                    |_| async move { Ok::<_, Infallible>(router) },
                ))
                .await;
        };
    }
}