Struct http_uri::HttpUri

pub struct HttpUri<'uri> { /* private fields */ }

A type representing valid http uri

Implementations

impl<'uri> HttpUri<'uri>

pub fn into_owned(self) -> HttpUri<'static>

make it’s lifetime static

pub fn normalize_inner_uri(&mut self)

Normalizes inner uri per rfc

pub fn has_explicit_default_port(&self) -> bool

Checks If explicit port of http uri is same as corresponding default port of it’s http(s) scheme,

pub fn remove_explicit_default_port(&mut self)

Removes explicit port, if explicit port of http uri is same as corresponding default port of it’s http(s) scheme, Otherwise, this method is no op.

pub fn remove_non_trailing_empty_segments(&mut self)

Removes non-trailing empty segments.

Methods from Deref<Target = URI<'uri>>

pub fn as_uri_reference(&self) -> &URIReference<'uri>

pub fn authority(&self) -> Option<&Authority<'uri>>

Returns the authority, if present, of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com:80/my/path").unwrap();
assert_eq!(uri.authority().unwrap().to_string(), "example.com:80");

pub fn can_be_a_base(&self) -> bool

Returns whether the URI can act as a base URI.

A URI can be a base if it is absolute (i.e. it has no fragment component).

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com/my/path").unwrap();
assert!(uri.can_be_a_base());

let uri = URI::try_from("ftp://127.0.0.1#fragment").unwrap();
assert!(!uri.can_be_a_base());

pub fn fragment(&self) -> Option<&Fragment<'uri>>

Returns the fragment, if present, of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com#fragment").unwrap();
assert_eq!(uri.fragment().unwrap(), "fragment");

pub fn has_authority(&self) -> bool

Returns whether the URI has an authority component.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com").unwrap();
assert!(uri.has_authority());

let uri = URI::try_from("urn:test").unwrap();
assert!(!uri.has_authority());

pub fn has_fragment(&self) -> bool

Returns whether the URI has a fragment component.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com#test").unwrap();
assert!(uri.has_fragment());

let uri = URI::try_from("http://example.com").unwrap();
assert!(!uri.has_fragment());

pub fn has_password(&self) -> bool

Returns whether the URI has a password component.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://user:pass@127.0.0.1").unwrap();
assert!(uri.has_password());

let uri = URI::try_from("http://user@127.0.0.1").unwrap();
assert!(!uri.has_password());

pub fn has_port(&self) -> bool

Returns whether the URI has a port.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://127.0.0.1:8080").unwrap();
assert!(uri.has_port());

let uri = URI::try_from("http://127.0.0.1").unwrap();
assert!(!uri.has_port());

pub fn has_query(&self) -> bool

Returns whether the URI has a query component.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com/my/path?my=query").unwrap();
assert!(uri.has_query());

let uri = URI::try_from("http://example.com/my/path").unwrap();
assert!(!uri.has_query());

pub fn has_username(&self) -> bool

Returns whether the URI has a username component.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://username@example.com").unwrap();
assert!(uri.has_username());

let uri = URI::try_from("http://example.com").unwrap();
assert!(!uri.has_username());

pub fn host(&self) -> Option<&Host<'uri>>

Returns the host, if present, of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://username@example.com").unwrap();
assert_eq!(uri.host().unwrap().to_string(), "example.com");

pub fn is_normalized(&self) -> bool

Returns whether the URI is normalized.

A normalized URI will have all of its components normalized.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com/?a=b").unwrap();
assert!(uri.is_normalized());

let mut uri = URI::try_from("http://EXAMPLE.com/?a=b").unwrap();
assert!(!uri.is_normalized());
uri.normalize();
assert!(uri.is_normalized());

pub fn path(&self) -> &Path<'uri>

Returns the path of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://127.0.0.1/my/path").unwrap();
assert_eq!(uri.path(), "/my/path");

pub fn password(&self) -> Option<&Password<'uri>>

Returns the password, if present, of the URI.

Usage of a password in URIs is deprecated.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://user:pass@example.com").unwrap();
assert_eq!(uri.password().unwrap(), "pass");

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

Returns the port, if present, of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://example.com:8080/").unwrap();
assert_eq!(uri.port().unwrap(), 8080);

pub fn query(&self) -> Option<&Query<'uri>>

Returns the query, if present, of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://127.0.0.1?my=query").unwrap();
assert_eq!(uri.query().unwrap(), "my=query");

pub fn resolve(&self, reference: &'uri URIReference<'uri>) -> URI<'uri>

Creates a new URI which is created by resolving the given reference against this URI.

The algorithm used for resolving the reference is described in [RFC3986, Section 5.2.2].

pub fn scheme(&self) -> &Scheme<'uri>

Returns the scheme of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://127.0.0.1/").unwrap();
assert_eq!(uri.scheme(), "http");

pub fn to_borrowed(&self) -> URI<'_>

Returns a new URI which is identical but has a lifetime tied to this URI.

This function will perform a memory allocation.

pub fn username(&self) -> Option<&Username<'uri>>

Returns the username, if present, of the URI.

Examples

use std::convert::TryFrom;

use uriparse::URI;

let uri = URI::try_from("http://username@example.com").unwrap();
assert_eq!(uri.username().unwrap(), "username");

Trait Implementations

impl<'uri> AsRef<str> for HttpUri<'uri>

fn as_ref(&self) -> &str

Performs the conversion.

impl<'uri, TI> Borrow<HttpUri<'uri>> for NormalHttpUri<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn borrow(&self) -> &HttpUri<'uri>

Immutably borrows from an owned value.

impl<'uri, TI> Borrow<HttpUri<'uri>> for HttpUriWithFragment<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn borrow(&self) -> &HttpUri<'uri>

Immutably borrows from an owned value.

impl<'uri, TI> Borrow<HttpUri<'uri>> for HttpUriWithQuery<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn borrow(&self) -> &HttpUri<'uri>

Immutably borrows from an owned value.

impl<'uri, TI> Borrow<HttpUri<'uri>> for HttpUriWithTslash<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn borrow(&self) -> &HttpUri<'uri>

Immutably borrows from an owned value.

impl<'uri, TI> Borrow<HttpUri<'uri>> for HttpUriSansFragment<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn borrow(&self) -> &HttpUri<'uri>

Immutably borrows from an owned value.

impl<'uri, TI> Borrow<HttpUri<'uri>> for HttpUriSansQuery<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn borrow(&self) -> &HttpUri<'uri>

Immutably borrows from an owned value.

impl<'uri, TI> Borrow<HttpUri<'uri>> for HttpUriSansTslash<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn borrow(&self) -> &HttpUri<'uri>

Immutably borrows from an owned value.

impl<'uri> Clone for HttpUri<'uri>

fn clone(&self) -> HttpUri<'uri>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'uri> Debug for HttpUri<'uri>

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

Formats the value using the given formatter.

impl<'uri> Deref for HttpUri<'uri>

type Target = URI<'uri>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'uri, TI> Into<HttpUri<'uri>> for NormalHttpUri<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn into(self) -> HttpUri<'uri>

Performs the conversion.

impl<'uri, TI> Into<HttpUri<'uri>> for HttpUriWithFragment<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn into(self) -> HttpUri<'uri>

Performs the conversion.

impl<'uri, TI> Into<HttpUri<'uri>> for HttpUriWithQuery<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn into(self) -> HttpUri<'uri>

Performs the conversion.

impl<'uri, TI> Into<HttpUri<'uri>> for HttpUriWithTslash<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn into(self) -> HttpUri<'uri>

Performs the conversion.

impl<'uri, TI> Into<HttpUri<'uri>> for HttpUriSansFragment<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn into(self) -> HttpUri<'uri>

Performs the conversion.

impl<'uri, TI> Into<HttpUri<'uri>> for HttpUriSansQuery<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn into(self) -> HttpUri<'uri>

Performs the conversion.

impl<'uri, TI> Into<HttpUri<'uri>> for HttpUriSansTslash<'uri, TI> where
    TI: TypeInvariant<HttpUri<'uri>> + Clone + PartialEq, 

fn into(self) -> HttpUri<'uri>

Performs the conversion.

impl<'uri> Into<URI<'uri>> for HttpUri<'uri>

fn into(self) -> URI<'uri>

Performs the conversion.

impl PartialEq<HttpUri<'_>> for HttpUri<'_>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'uri> TryFrom<&'uri str> for HttpUri<'uri>

type Error = InvalidHttpUriSource<'uri>

The type returned in the event of a conversion error.

fn try_from(uri_str: &'uri str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'uri, HUI> TryFrom<Cow<'a, HUI>> for HttpUri<'uri> where
    HUI: TypeInvariant<HttpUri<'uri>> + Clone, 

Implementation in parity with remaining other invariants

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(uri_invariant: Cow<'a, HUI>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'uri> TryFrom<HttpUri<'uri>> for AbsoluteNormalizedHttpUri<'uri>

type Error = AbsoluteNormalizedHttpUriRequirementViolation<'uri>

The type returned in the event of a conversion error.

fn try_from(http_uri: HttpUri<'uri>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'uri> TryFrom<HttpUri<'uri>> for HierarchicalNormalizedHttpUri<'uri>

type Error = HierarchicalNormalizedHttpUriRequirementViolation<'uri>

The type returned in the event of a conversion error.

fn try_from(http_uri: HttpUri<'uri>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'uri> TryFrom<HttpUri<'uri>> for HierarchicalNormalizedHttpUriWithTslash<'uri>

type Error = HierarchicalNormalizedHttpUriWithTslashRequirementViolation<'uri>

The type returned in the event of a conversion error.

fn try_from(http_uri: HttpUri<'uri>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'uri> TryFrom<HttpUri<'uri>> for NormalizedHttpUri<'uri>

type Error = NormalizedHttpUriRequirementViolation<'uri>

The type returned in the event of a conversion error.

fn try_from(http_uri: HttpUri<'uri>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'uri> TryFrom<URI<'uri>> for HttpUri<'uri>

type Error = HttpUriRequirementViolation<'uri>

The type returned in the event of a conversion error.

fn try_from(uri: URI<'uri>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'uri> HttpUriNormalizationOrthogonal<'uri> for HttpUri<'uri>