document_tree/
url.rs

Help
1use std::fmt;
2use std::str::FromStr;
3
4use serde_derive::Serialize;
5use url::{self, ParseError};
6
7fn starts_with_scheme(input: &str) -> bool {
8    let scheme = input.split(':').next().unwrap();
9    if scheme == input || scheme.is_empty() {
10        return false;
11    }
12    let mut chars = input.chars();
13    // First character.
14    if !chars.next().unwrap().is_ascii_alphabetic() {
15        return false;
16    }
17    for ch in chars {
18        if !ch.is_ascii_alphanumeric() && ch != '+' && ch != '-' && ch != '.' {
19            return false;
20        }
21    }
22    true
23}
24
25/// The string representation of a URL, either absolute or relative, that has
26/// been verified as a valid URL on construction.
27#[derive(Debug, PartialEq, Serialize, Clone)]
28#[serde(transparent)]
29pub struct Url(String);
30
31impl Url {
32    /// Parse an absolute URL.
33    ///
34    /// # Errors
35    /// Returns an error if the string is not a valid absolute URL.
36    pub fn parse_absolute(input: &str) -> Result<Self, ParseError> {
37        Ok(url::Url::parse(input)?.into())
38    }
39
40    /// Parse a relative path as URL.
41    ///
42    /// # Errors
43    /// Returns an error if the string is not a relative path or can’t be converted to an url.
44    #[allow(clippy::missing_panics_doc)]
45    pub fn parse_relative(input: &str) -> Result<Self, ParseError> {
46        // We're assuming that any scheme through which RsT documents are being
47        // accessed is a hierarchical scheme, and so we can parse relative to a
48        // random hierarchical URL.
49        if input.starts_with('/') || !starts_with_scheme(input) {
50            // Continue only if the parse succeeded, disregarding its result.
51            let random_base_url = url::Url::parse("https://a/b").unwrap();
52            url::Url::options()
53                .base_url(Some(&random_base_url))
54                .parse(input)?;
55            Ok(Url(input.into()))
56        } else {
57            // If this is a URL at all, it's an absolute one.
58            // There's no appropriate variant of url::ParseError really.
59            Err(ParseError::SetHostOnCannotBeABaseUrl)
60        }
61    }
62    #[must_use]
63    pub fn as_str(&self) -> &str {
64        self.0.as_str()
65    }
66}
67
68impl From<url::Url> for Url {
69    fn from(url: url::Url) -> Self {
70        Url(url.into())
71    }
72}
73
74impl fmt::Display for Url {
75    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
76        write!(f, "{}", self.as_str())
77    }
78}
79
80impl FromStr for Url {
81    type Err = ParseError;
82    fn from_str(input: &str) -> Result<Self, Self::Err> {
83        Url::parse_absolute(input).or_else(|_| Url::parse_relative(input))
84    }
85}
document_tree/url.rs

document_tree/
url.rs
