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

use std::fmt::{Display, Formatter};

use crate::parse::Error;
use crate::parse::Error::InvalidScheme;

/// A web-based URL scheme.
///
/// # RFC 3986
/// https://datatracker.ietf.org/doc/html/rfc3986#section-3.1
#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug)]
pub struct Scheme<'a> {
    scheme: &'a str,
}

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

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

        Self { scheme }
    }
}

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

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

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

    /// Checks if the char `c` is a valid first char.
    fn is_valid_first_char(c: u8, ignore_case: bool) -> bool {
        c.is_ascii_lowercase() || (ignore_case && c.is_ascii_uppercase())
    }

    /// Checks if the char `c` is a valid scheme char.
    fn is_valid_char(c: u8, ignore_case: bool) -> bool {
        Self::is_valid_first_char(c, ignore_case)
            || c.is_ascii_digit()
            || c == b'+'
            || c == b'-'
            || c == b'.'
    }

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

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

    /// Gets the scheme string.
    pub const fn as_str(&self) -> &str {
        self.scheme
    }
}

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

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

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

    #[test]
    fn new() {
        let scheme: Scheme = unsafe { Scheme::new("scheme") };
        assert_eq!(scheme.scheme, "scheme");
    }

    #[test]
    fn try_from_str() {
        assert_eq!(Scheme::try_from("http").unwrap().as_str(), "http");
        assert_eq!(Scheme::try_from("a0+-.").unwrap().as_str(), "a0+-.");
        assert_eq!(Scheme::try_from(""), Err(InvalidScheme));
        assert_eq!(Scheme::try_from("0abc"), Err(InvalidScheme));
        assert_eq!(Scheme::try_from("a~"), Err(InvalidScheme));
        assert_eq!(Scheme::try_from("ABC"), Err(InvalidScheme));
    }

    #[test]
    fn is_valid() {
        let test_cases: &[(&str, bool, bool)] = &[
            ("", false, false),
            ("A", true, false),
            ("a", true, true),
            ("0", false, false),
            ("a~", false, false),
            ("az09+-.", true, true),
            ("azAZ09+-.", true, false),
        ];
        for (scheme, expected_ic_true, expected_ic_false) in test_cases {
            let result: bool = Scheme::is_valid(scheme, true);
            assert_eq!(result, *expected_ic_true, "scheme={}", scheme);

            let result: bool = Scheme::is_valid(scheme, false);
            assert_eq!(result, *expected_ic_false, "scheme={}", scheme);
        }
    }

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