atomic_http 0.11.1

High level HTTP server library
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
use std::fmt;

use http::Method;

/// Error returned when inserting a route fails.
#[derive(Debug)]
pub struct InsertError(matchit::InsertError);

impl fmt::Display for InsertError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl std::error::Error for InsertError {}

/// Zero-copy path parameters extracted from a matched route.
///
/// Parameter keys (e.g. `"id"`) reference the router's internal trie,
/// and values (e.g. `"42"`) reference the original request path — no
/// allocations are performed during matching.
pub struct Params<'k, 'v>(matchit::Params<'k, 'v>);

impl<'k, 'v> Params<'k, 'v> {
    /// Get a parameter value by name.
    ///
    /// ```text
    /// route: "/users/{id}"
    /// path:  "/users/42"
    /// params.get("id") => Some("42")
    /// ```
    pub fn get(&self, key: &str) -> Option<&'v str> {
        self.0.get(key)
    }

    /// Iterate over all `(key, value)` pairs.
    pub fn iter(&self) -> matchit::ParamsIter<'_, 'k, 'v> {
        self.0.iter()
    }

    /// Returns `true` if there are no parameters.
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Returns the number of parameters.
    pub fn len(&self) -> usize {
        self.0.len()
    }
}

/// A matched route containing the stored value and extracted parameters.
pub struct Match<'k, 'v, V> {
    pub value: &'v V,
    pub params: Params<'k, 'v>,
}

/// A method-aware HTTP router backed by a radix trie.
///
/// `V` is the value type stored per route — typically an enum variant,
/// string tag, or handler identifier.
///
/// # Example
///
/// ```rust,no_run
/// use atomic_http::router::Router;
///
/// enum Route { Home, GetUser, CreateUser }
///
/// let router = Router::new()
///     .get("/", Route::Home)
///     .get("/users/{id}", Route::GetUser)
///     .post("/users", Route::CreateUser);
/// ```
pub struct Router<V> {
    trees: Vec<(Method, matchit::Router<V>)>,
}

impl<V> Router<V> {
    /// Create an empty router.
    pub fn new() -> Self {
        Self { trees: Vec::new() }
    }

    /// Insert a route for the given HTTP method and path pattern.
    ///
    /// Path patterns support:
    /// - Named parameters: `/users/{id}`
    /// - Catch-all: `/files/{*path}`
    pub fn insert(&mut self, method: Method, path: &str, value: V) -> Result<(), InsertError> {
        if let Some((_, tree)) = self.trees.iter_mut().find(|(m, _)| *m == method) {
            tree.insert(path, value).map_err(InsertError)?;
        } else {
            let mut tree = matchit::Router::new();
            tree.insert(path, value).map_err(InsertError)?;
            self.trees.push((method, tree));
        }
        Ok(())
    }

    /// Look up a route by HTTP method and path.
    ///
    /// Returns `None` if no route matches. The returned [`Match`] contains
    /// a reference to the stored value and zero-copy [`Params`].
    pub fn find<'k, 'v>(&'k self, method: &Method, path: &'v str) -> Option<Match<'k, 'v, V>>
    where
        'k: 'v,
    {
        self.trees
            .iter()
            .find(|(m, _)| m == method)
            .and_then(|(_, tree)| tree.at(path).ok())
            .map(move |m| Match {
                value: m.value,
                params: Params(m.params),
            })
    }

    // ── Builder methods (consume self for chaining) ──

    /// Register a `GET` route.
    pub fn get(mut self, path: &str, value: V) -> Self {
        self.insert(Method::GET, path, value)
            .expect("failed to insert GET route");
        self
    }

    /// Register a `POST` route.
    pub fn post(mut self, path: &str, value: V) -> Self {
        self.insert(Method::POST, path, value)
            .expect("failed to insert POST route");
        self
    }

    /// Register a `PUT` route.
    pub fn put(mut self, path: &str, value: V) -> Self {
        self.insert(Method::PUT, path, value)
            .expect("failed to insert PUT route");
        self
    }

    /// Register a `DELETE` route.
    pub fn delete(mut self, path: &str, value: V) -> Self {
        self.insert(Method::DELETE, path, value)
            .expect("failed to insert DELETE route");
        self
    }

    /// Register a `PATCH` route.
    pub fn patch(mut self, path: &str, value: V) -> Self {
        self.insert(Method::PATCH, path, value)
            .expect("failed to insert PATCH route");
        self
    }

    /// Register a `HEAD` route.
    pub fn head(mut self, path: &str, value: V) -> Self {
        self.insert(Method::HEAD, path, value)
            .expect("failed to insert HEAD route");
        self
    }

    /// Register an `OPTIONS` route.
    pub fn options(mut self, path: &str, value: V) -> Self {
        self.insert(Method::OPTIONS, path, value)
            .expect("failed to insert OPTIONS route");
        self
    }

    /// Register a route for an arbitrary HTTP method.
    pub fn route(mut self, method: Method, path: &str, value: V) -> Self {
        self.insert(method, path, value)
            .expect("failed to insert route");
        self
    }

    /// Group routes under a common path prefix.
    ///
    /// Scopes can be nested arbitrarily. All routes registered inside the
    /// scope closure will have the prefix prepended automatically.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// use atomic_http::router::Router;
    ///
    /// enum Route { ListUsers, GetUser, CreateUser }
    ///
    /// let router = Router::new()
    ///     .scope("/api/v1", |s| s
    ///         .scope("/users", |s| s
    ///             .get("/", Route::ListUsers)
    ///             .get("/{id}", Route::GetUser)
    ///             .post("/", Route::CreateUser)
    ///         )
    ///     );
    /// ```
    pub fn scope(
        mut self,
        prefix: &str,
        f: impl FnOnce(ScopeBuilder<V>) -> ScopeBuilder<V>,
    ) -> Self {
        let scope = ScopeBuilder {
            prefix: prefix.to_string(),
            entries: Vec::new(),
        };
        let scope = f(scope);
        for (method, path, value) in scope.entries {
            self.insert(method, &path, value)
                .expect("failed to insert scoped route");
        }
        self
    }
}

/// Builder for registering routes under a common path prefix.
///
/// Created by [`Router::scope`]. Supports nested scopes via
/// [`ScopeBuilder::scope`].
pub struct ScopeBuilder<V> {
    prefix: String,
    entries: Vec<(Method, String, V)>,
}

impl<V> ScopeBuilder<V> {
    fn push(mut self, method: Method, path: &str, value: V) -> Self {
        self.entries
            .push((method, format!("{}{}", self.prefix, path), value));
        self
    }

    /// Register a `GET` route under this scope's prefix.
    pub fn get(self, path: &str, value: V) -> Self {
        self.push(Method::GET, path, value)
    }

    /// Register a `POST` route under this scope's prefix.
    pub fn post(self, path: &str, value: V) -> Self {
        self.push(Method::POST, path, value)
    }

    /// Register a `PUT` route under this scope's prefix.
    pub fn put(self, path: &str, value: V) -> Self {
        self.push(Method::PUT, path, value)
    }

    /// Register a `DELETE` route under this scope's prefix.
    pub fn delete(self, path: &str, value: V) -> Self {
        self.push(Method::DELETE, path, value)
    }

    /// Register a `PATCH` route under this scope's prefix.
    pub fn patch(self, path: &str, value: V) -> Self {
        self.push(Method::PATCH, path, value)
    }

    /// Register a `HEAD` route under this scope's prefix.
    pub fn head(self, path: &str, value: V) -> Self {
        self.push(Method::HEAD, path, value)
    }

    /// Register an `OPTIONS` route under this scope's prefix.
    pub fn options(self, path: &str, value: V) -> Self {
        self.push(Method::OPTIONS, path, value)
    }

    /// Register a route for an arbitrary HTTP method under this scope's prefix.
    pub fn route(self, method: Method, path: &str, value: V) -> Self {
        self.push(method, path, value)
    }

    /// Create a nested scope with an additional prefix.
    pub fn scope(
        mut self,
        prefix: &str,
        f: impl FnOnce(ScopeBuilder<V>) -> ScopeBuilder<V>,
    ) -> Self {
        let nested = ScopeBuilder {
            prefix: format!("{}{}", self.prefix, prefix),
            entries: Vec::new(),
        };
        let nested = f(nested);
        self.entries.extend(nested.entries);
        self
    }
}

impl<V> Default for Router<V> {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[derive(Debug, PartialEq)]
    enum Route {
        Home,
        GetUser,
        CreateUser,
        ServeFile,
    }

    #[test]
    fn basic_routing() {
        let router = Router::new()
            .get("/", Route::Home)
            .get("/users/{id}", Route::GetUser)
            .post("/users", Route::CreateUser);

        let m = router.find(&Method::GET, "/").unwrap();
        assert_eq!(*m.value, Route::Home);
        assert!(m.params.is_empty());

        let m = router.find(&Method::GET, "/users/42").unwrap();
        assert_eq!(*m.value, Route::GetUser);
        assert_eq!(m.params.get("id"), Some("42"));

        let m = router.find(&Method::POST, "/users").unwrap();
        assert_eq!(*m.value, Route::CreateUser);
    }

    #[test]
    fn wildcard_params() {
        let router = Router::new().get("/files/{*path}", Route::ServeFile);

        let m = router.find(&Method::GET, "/files/images/logo.png").unwrap();
        assert_eq!(*m.value, Route::ServeFile);
        assert_eq!(m.params.get("path"), Some("images/logo.png"));
    }

    #[test]
    fn method_mismatch() {
        let router = Router::new().get("/users", Route::GetUser);

        assert!(router.find(&Method::POST, "/users").is_none());
    }

    #[test]
    fn not_found() {
        let router = Router::new().get("/", Route::Home);

        assert!(router.find(&Method::GET, "/nonexistent").is_none());
    }

    #[test]
    fn multiple_params() {
        let router = Router::new().get("/orgs/{org}/repos/{repo}", Route::GetUser);

        let m = router
            .find(&Method::GET, "/orgs/acme/repos/widget")
            .unwrap();
        assert_eq!(m.params.get("org"), Some("acme"));
        assert_eq!(m.params.get("repo"), Some("widget"));
        assert_eq!(m.params.len(), 2);
    }

    #[test]
    fn same_path_different_methods() {
        let router = Router::new()
            .get("/users", Route::GetUser)
            .post("/users", Route::CreateUser);

        let m = router.find(&Method::GET, "/users").unwrap();
        assert_eq!(*m.value, Route::GetUser);

        let m = router.find(&Method::POST, "/users").unwrap();
        assert_eq!(*m.value, Route::CreateUser);
    }

    #[test]
    fn insert_returns_error_on_conflict() {
        let mut router = Router::<Route>::new();
        router
            .insert(Method::GET, "/users/{id}", Route::GetUser)
            .unwrap();
        assert!(router
            .insert(Method::GET, "/users/{name}", Route::GetUser)
            .is_err());
    }

    #[test]
    fn params_iter() {
        let router = Router::new().get("/a/{x}/b/{y}", Route::Home);

        let m = router.find(&Method::GET, "/a/1/b/2").unwrap();
        let pairs: Vec<_> = m.params.iter().collect();
        assert_eq!(pairs, vec![("x", "1"), ("y", "2")]);
    }

    #[test]
    fn scope_basic() {
        let router = Router::new().get("/", Route::Home).scope("/api", |s| {
            s.get("/users", Route::GetUser)
                .post("/users", Route::CreateUser)
        });

        let m = router.find(&Method::GET, "/api/users").unwrap();
        assert_eq!(*m.value, Route::GetUser);

        let m = router.find(&Method::POST, "/api/users").unwrap();
        assert_eq!(*m.value, Route::CreateUser);

        // Root still works
        let m = router.find(&Method::GET, "/").unwrap();
        assert_eq!(*m.value, Route::Home);
    }

    #[test]
    fn scope_nested() {
        let router = Router::new().scope("/api/v1", |s| {
            s.scope("/users", |s| {
                s.get("/", Route::GetUser)
                    .get("/{id}", Route::GetUser)
                    .post("/", Route::CreateUser)
            })
            .scope("/files", |s| s.get("/{*path}", Route::ServeFile))
        });

        let m = router.find(&Method::GET, "/api/v1/users/").unwrap();
        assert_eq!(*m.value, Route::GetUser);

        let m = router.find(&Method::GET, "/api/v1/users/42").unwrap();
        assert_eq!(m.params.get("id"), Some("42"));

        let m = router
            .find(&Method::GET, "/api/v1/files/img/logo.png")
            .unwrap();
        assert_eq!(m.params.get("path"), Some("img/logo.png"));
    }
}