web-url 0.10.0

This library aids in processing web-based URLs.
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

use crate::parse::Error;
use crate::parse::Error::InvalidFragment;
use std::fmt::{Display, Formatter};

/// A web-based URL fragment.
///
/// # Validation
/// A fragment will never be empty and will always start with a '#'.
///
/// The fragment string can contain any US-ASCII letter, number, or punctuation char.
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub struct Fragment<'a> {
    fragment: &'a str,
}

impl Default for Fragment<'static> {
    fn default() -> Self {
        Self { fragment: "#" }
    }
}

impl<'a> Fragment<'a> {
    //! Construction

    /// Creates a new fragment.
    ///
    /// # Safety
    /// The `fragment` must be valid.
    pub unsafe fn new(fragment: &'a str) -> Self {
        debug_assert!(Self::is_valid(fragment));

        Self { fragment }
    }
}

impl<'a> TryFrom<&'a str> for Fragment<'a> {
    type Error = Error;

    fn try_from(fragment: &'a str) -> Result<Self, Self::Error> {
        if Self::is_valid(fragment) {
            Ok(Self { fragment })
        } else {
            Err(InvalidFragment)
        }
    }
}

impl<'a> Fragment<'a> {
    //! Validation

    /// Checks if the char `c` is valid.
    fn is_valid_char(c: u8) -> bool {
        c.is_ascii_alphanumeric() || c.is_ascii_punctuation()
    }

    /// Checks if the `fragment` is valid.
    pub fn is_valid(fragment: &str) -> bool {
        !fragment.is_empty()
            && fragment.as_bytes()[0] == b'#'
            && fragment.as_bytes()[1..]
                .iter()
                .all(|c| Self::is_valid_char(*c))
    }
}

impl<'a> Fragment<'a> {
    //! Display

    /// Gets the fragment value. (will not contain the '#' prefix)
    pub fn value(&self) -> &str {
        &self.fragment[1..]
    }

    /// Gets the fragment string. (will contain the '#' prefix)
    pub const fn as_str(&self) -> &str {
        self.fragment
    }
}

impl<'a> AsRef<str> for Fragment<'a> {
    fn as_ref(&self) -> &str {
        self.fragment
    }
}

impl<'a> Display for Fragment<'a> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.fragment)
    }
}

#[cfg(test)]
mod tests {
    use crate::parse::Error::InvalidFragment;
    use crate::Fragment;

    #[test]
    fn new() {
        let fragment: Fragment = unsafe { Fragment::new("#the-fragment") };
        assert_eq!(fragment.fragment, "#the-fragment");
    }

    #[test]
    fn default() {
        let fragment: Fragment = Fragment::default();
        assert_eq!(fragment.as_str(), "#");
        assert_eq!(fragment.value(), "");
    }

    #[test]
    fn try_from_str() {
        assert_eq!(Fragment::try_from("#").unwrap().as_str(), "#");
        assert_eq!(Fragment::try_from("#section").unwrap().as_str(), "#section");
        assert_eq!(Fragment::try_from(""), Err(InvalidFragment));
        assert_eq!(Fragment::try_from("no-hash"), Err(InvalidFragment));
        assert_eq!(Fragment::try_from("# space"), Err(InvalidFragment));
    }

    #[test]
    fn value() {
        let fragment: Fragment = unsafe { Fragment::new("#the-fragment") };
        assert_eq!(fragment.value(), "the-fragment");

        let fragment: Fragment = unsafe { Fragment::new("#") };
        assert_eq!(fragment.value(), "");
    }

    #[test]
    fn is_valid() {
        let test_cases: &[(&str, bool)] = &[
            ("", false),
            ("#", true),
            ("###", true),
            ("#azAZ09", true),
            ("#!/&/=/~/", true),
            ("#?", true),
            ("#!", true),
            ("# ", false),
            ("# x", false),
        ];
        for (fragment, expected) in test_cases {
            let result: bool = Fragment::is_valid(fragment);
            assert_eq!(result, *expected, "fragment={}", fragment);
        }
    }

    #[test]
    fn display() {
        let fragment: Fragment = unsafe { Fragment::new("#the-fragment") };
        assert_eq!(fragment.as_str(), "#the-fragment");
        assert_eq!(fragment.as_ref(), "#the-fragment");
        assert_eq!(fragment.to_string(), "#the-fragment");
    }
}