      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

    // Copyright 2015-2017 Parity Technologies (UK) Ltd.
    // This file is part of Parity.

    // Parity is free software: you can redistribute it and/or modify
    // it under the terms of the GNU General Public License as published by
    // the Free Software Foundation, either version 3 of the License, or
    // (at your option) any later version.

    // Parity is distributed in the hope that it will be useful,
    // but WITHOUT ANY WARRANTY; without even the implied warranty of
    // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    // GNU General Public License for more details.

    // You should have received a copy of the GNU General Public License
    // along with Parity.  If not, see <http://www.gnu.org/licenses/>.

    //! HTTP/HTTPS URL type. Based on URL type from Iron library.

    use url_lib::{self};
    pub use url_lib::Host;

    /// HTTP/HTTPS URL type for Iron.
    #[derive(PartialEq, Eq, Clone, Debug)]
    pub struct Url {
    	/// Raw url of url
    	pub raw: url_lib::Url,

    	/// The host field of the URL, probably a domain.
    	pub host: Host,

    	/// The connection port.
    	pub port: u16,

    	/// The URL path, the resource to be accessed.
    	///
    	/// A *non-empty* vector encoding the parts of the URL path.
    	/// Empty entries of `""` correspond to trailing slashes.
    	pub path: Vec<String>,

    	/// The URL query.
    	pub query: Option<String>,

    	/// The URL username field, from the userinfo section of the URL.
    	///
    	/// `None` if the `@` character was not part of the input OR
    	/// if a blank username was provided.
    	/// Otherwise, a non-empty string.
    	pub username: Option<String>,

    	/// The URL password field, from the userinfo section of the URL.
    	///
    	/// `None` if the `@` character was not part of the input OR
    	/// if a blank password was provided.
    	/// Otherwise, a non-empty string.
    	pub password: Option<String>,
    }

    impl Url {
    	/// Create a URL from a string.
    	///
    	/// The input must be a valid URL with a special scheme for this to succeed.
    	///
    	/// HTTP and HTTPS are special schemes.
    	///
    	/// See: http://url.spec.whatwg.org/#special-scheme
    	pub fn parse(input: &str) -> Result<Url, String> {
    		// Parse the string using rust-url, then convert.
    		match url_lib::Url::parse(input) {
    			Ok(raw_url) => Url::from_generic_url(raw_url),
    			Err(e) => Err(format!("{}", e))
    		}
    	}

    	/// Create a `Url` from a `rust-url` `Url`.
    	pub fn from_generic_url(raw_url: url_lib::Url) -> Result<Url, String> {
    		// Map empty usernames to None.
    		let username = match raw_url.username() {
    			"" => None,
    			username => Some(username.to_owned())
    		};

    		// Map empty passwords to None.
    		let password = match raw_url.password() {
    			Some(password) if !password.is_empty() => Some(password.to_owned()),
    			_ => None,
    		};

    		let port = raw_url.port_or_known_default().ok_or_else(|| format!("Unknown port for scheme: `{}`", raw_url.scheme()))?;
    		let host = raw_url.host().ok_or_else(|| "Valid host, because only data:, mailto: protocols does not have host.".to_owned())?.to_owned();
    		let path = raw_url.path_segments().ok_or_else(|| "Valid path segments. In HTTP we won't get cannot-be-a-base URLs".to_owned())?
    					.map(|part| part.to_owned()).collect();
    		let query = raw_url.query().map(|x| x.to_owned());

    		Ok(Url {
    			port: port,
    			host: host,
    			path: path,
    			query: query,
    			raw: raw_url,
    			username: username,
    			password: password,
    		})
    	}
    }

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

        #[test]
        fn test_default_port() {
            assert_eq!(Url::parse("http://example.com/wow").unwrap().port, 80u16);
            assert_eq!(Url::parse("https://example.com/wow").unwrap().port, 443u16);
        }

        #[test]
        fn test_explicit_port() {
            assert_eq!(Url::parse("http://localhost:3097").unwrap().port, 3097u16);
        }

        #[test]
        fn test_empty_username() {
            assert!(Url::parse("http://@example.com").unwrap().username.is_none());
            assert!(Url::parse("http://:password@example.com").unwrap().username.is_none());
        }

        #[test]
        fn test_not_empty_username() {
            let user = Url::parse("http://john:pass@example.com").unwrap().username;
            assert_eq!(user.unwrap(), "john");

            let user = Url::parse("http://john:@example.com").unwrap().username;
            assert_eq!(user.unwrap(), "john");
        }

        #[test]
        fn test_empty_password() {
            assert!(Url::parse("http://michael@example.com").unwrap().password.is_none());
            assert!(Url::parse("http://:@example.com").unwrap().password.is_none());
        }

        #[test]
        fn test_not_empty_password() {
            let pass = Url::parse("http://michael:pass@example.com").unwrap().password;
            assert_eq!(pass.unwrap(), "pass");

            let pass = Url::parse("http://:pass@example.com").unwrap().password;
            assert_eq!(pass.unwrap(), "pass");
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)