Struct HttpUrl 

pub struct HttpUrl { /* private fields */ }

An immutable, parsed HTTP or HTTPS URL.

Example

use http_url::HttpUrl;

let url = HttpUrl::parse("https://example.com/path?a=1#frag").unwrap();
assert_eq!(url.scheme(), "https");
assert_eq!(url.host(), "example.com");
assert_eq!(url.path(), "/path");
assert_eq!(url.query_parameter("a"), Some("1"));
assert_eq!(url.fragment(), Some("frag"));

Implementations

impl HttpUrl

pub fn parse(url: &str) -> Result<Self>

Parse a URL string into an HttpUrl.

The URL must have an http:// or https:// scheme.

impl HttpUrl

pub fn builder() -> HttpUrlBuilder

Create a new builder.

pub fn new_builder(&self) -> HttpUrlBuilder

Create a builder pre-populated with this URL’s components.

pub fn scheme(&self) -> Scheme

Returns the URL scheme.

pub fn is_https(&self) -> bool

Returns true if the scheme is https.

pub fn username(&self) -> &str

Returns the username (empty string if not present).

pub fn password(&self) -> &str

Returns the password (empty string if not present).

pub fn host(&self) -> &str

Returns the host (domain, IPv4, or bracketed IPv6).

pub fn port(&self) -> u16

The explicit port, or the default port for the scheme if none was set.

pub fn explicit_port(&self) -> Option<u16>

The port only if it differs from the scheme’s default.

pub fn path_segments(&self) -> &[String]

The decoded path segments.

pub fn encoded_path(&self) -> String

The encoded path (with leading /), e.g. /a/b/c.

pub fn path(&self) -> String

The decoded path as a string, e.g. /a/b/c.

pub fn encoded_query(&self) -> Option<String>

Returns the query string (percent-encoded), or None if there are no parameters.

pub fn query(&self) -> Option<String>

Returns the decoded query string, or None.

pub fn query_parameter(&self, name: &str) -> Option<&str>

Get the first value for a query parameter name.

pub fn query_parameters(&self, name: &str) -> Vec<&str>

Get all values for a query parameter name.

pub fn query_parameter_names(&self) -> Vec<&str>

Returns the set of unique query parameter names.

pub fn query_size(&self) -> usize

Number of query parameters.

pub fn fragment(&self) -> Option<&str>

The fragment (decoded), if any.

pub fn encoded_fragment(&self) -> Option<String>

The fragment (percent-encoded), if any.

pub fn resolve(&self, link: &str) -> Result<HttpUrl>

Resolve a relative URL against this one.

This follows the algorithm from RFC 3986 Section 5.

pub fn top_private_domain(&self) -> Option<String>

Compute the top private domain (eTLD+1) of this URL’s host.

Returns None if the host is an IP address or does not have enough domain labels. This is a simplified version; a full implementation would use the Public Suffix List.

pub fn to_url_string(&self) -> String

The full URL string (percent-encoded).

Trait Implementations

impl Clone for HttpUrl

fn clone(&self) -> HttpUrl

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpUrl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for HttpUrl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for HttpUrl

impl FromStr for HttpUrl

type Err = HttpUrlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for HttpUrl

fn eq(&self, other: &HttpUrl) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HttpUrl