Struct HttpUrl 

pub struct HttpUrl(/* private fields */);

An immutable HTTP or HTTPS URL.

HttpUrl is a thin newtype around url::Url that enforces the “scheme is http or https” invariant at construction time. Parsing, percent-encoding, normalization and all component access are provided by the url crate — reach them through HttpUrl::as_url or HttpUrl::into_url. This crate focuses on the HttpUrlBuilder API for constructing URLs programmatically, plus a typed Scheme accessor that reflects the http/https invariant.

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.as_url().host_str(), Some("example.com"));
assert_eq!(url.as_url().path(), "/path");
assert_eq!(url.as_url().query(), Some("a=1"));
assert_eq!(url.as_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; all other parsing behavior follows the WHATWG URL Standard as implemented by the url crate.

pub fn from_url(url: Url) -> Result<Self>

Wrap an existing url::Url, returning an error if its scheme is not http or https.

pub fn as_url(&self) -> &Url

Borrow the underlying url::Url, through which all URL components (host, path, query, fragment, …) are accessible.

pub fn into_url(self) -> Url

Consume this HttpUrl and return the underlying url::Url.

pub fn builder() -> HttpUrlBuilder

Create a new HttpUrlBuilder.

pub fn new_builder(&self) -> HttpUrlBuilder

Create a builder pre-populated with this URL’s components, so it can be modified and rebuilt.

Example

use http_url::HttpUrl;

let url = HttpUrl::parse("https://example.com/a/b?q=1").unwrap();
let url2 = url.new_builder()
    .add_path_segment("c")
    .build()
    .unwrap();
assert_eq!(url2.as_url().path(), "/a/b/c");

pub fn scheme(&self) -> Scheme

Returns the URL scheme as a typed Scheme.

This is the typed mirror of url::Url::scheme; for a valid HttpUrl it is always http or https.

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 implementation that assumes the last two labels form the private domain; a full implementation would consult the Public Suffix List.

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 From<HttpUrl> for Url

fn from(http: HttpUrl) -> Self

Converts to this type from the input type.

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 Hash for HttpUrl

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HttpUrl

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HttpUrl

impl TryFrom<Url> for HttpUrl

type Error = HttpUrlError

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<Self>

Performs the conversion.