via-router 3.0.0-beta.2

A fast and flexible 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

use std::fmt::{self, Debug, Display};

#[derive(PartialEq)]
pub enum Pattern {
    Root,
    Static(Param),
    Dynamic(Param),
    Wildcard(Param),
}

/// An identifier for a named path segment.
///
#[derive(Debug, PartialEq)]
pub struct Param {
    ident: Box<str>,
}

/// Returns an iterator that yields a `Pattern` for each segment in the uri path.
///
pub fn patterns(path: &'static str) -> impl Iterator<Item = Pattern> {
    let mut segments = vec![];

    super::split(&mut segments, path);
    segments.into_iter().map(|at| {
        let end = at.end();
        let start = at.start();
        let segment = match path.get(start..end) {
            Some(slice) => slice,
            None => panic!("Path segments cannot be empty when defining a route."),
        };

        match segment.chars().next() {
            // Path segments that start with a colon are considered a Dynamic
            // pattern. The remaining characters in the segment are considered
            // the name or identifier associated with the parameter.
            Some(':') => {
                let param = Param::new(match segment.get(1..) {
                    None | Some("") => panic!("Dynamic parameters must be named. Found ':'."),
                    Some(rest) => rest,
                });

                Pattern::Dynamic(param)
            }

            // Path segments that start with an asterisk are considered CatchAll
            // pattern. The remaining characters in the segment are considered
            // the name or identifier associated with the parameter.
            Some('*') => {
                let param = Param::new(match segment.get(1..) {
                    None | Some("") => panic!("Wildcard parameters must be named. Found '*'."),
                    Some(rest) => rest,
                });

                Pattern::Wildcard(param)
            }

            // The segment does not start with a reserved character. We will
            // consider it a static pattern that can be matched by value.
            _ => {
                let param = Param::new(segment);
                Pattern::Static(param)
            }
        }
    })
}

impl Param {
    pub fn as_str(&self) -> &str {
        &self.ident
    }
}

impl Param {
    pub(crate) fn new(ident: &str) -> Self {
        Self {
            ident: ident.into(),
        }
    }
}

impl Clone for Param {
    #[inline]
    fn clone(&self) -> Self {
        Self {
            ident: self.ident.clone(),
        }
    }
}

impl Display for Param {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        Display::fmt(&self.ident, f)
    }
}