Struct UriRawComponents

pub struct UriRawComponents<'a> { /* private fields */ }

Struct that holds parsed URI components.

Internally, all components are referenced in raw/escaped form, but this type does provide methods for convenient decoded/unescaped access.

Instances of this type are usually created by calling a method named components() on the URI type you are working with.

That this struct implements AnyUriRef, allowing it to be used as an argument wherever a AnyUriRef is accepted.

Implementations

impl<'a> UriRawComponents<'a>

pub fn from_str(uri: &'a str) -> Result<UriRawComponents<'a>, ParseError>

Constructs a new UriRawComponents from the given string slice, which is assumed to contain a URI-reference.

pub fn scheme(&self) -> Option<&'a str>

Returns the slice of the URI that describes the URI scheme, if present. Percent encoding is not allowed in the scheme, so no decoding is required.

pub fn raw_authority(&self) -> Option<&'a str>

Returns the escaped slice of the URI that contains the “authority”, if present.

See UriRawComponents::authority for the percent-decoded version.

pub fn raw_userinfo(&self) -> Option<&'a str>

Returns the escaped slice of the URI that contains the “userinfo”, if present.

See UriRawComponents::userinfo for the percent-decoded version.

pub fn raw_host(&self) -> Option<&'a str>

Returns the escaped slice of the URI that contains the “host”, if present.

See UriRawComponents::host for the percent-decoded version.

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

Returns the 16-bit representation of the port number, if present in the authority.

pub fn raw_path(&self) -> &'a str

Returns the escaped slice of the URI that contains the “path”.

See UriRawComponents::path for the percent-decoded version.

pub fn path_as_rel_ref(&self) -> &'a RelRef

Returns the subset of this URI that is a path, without the scheme, authority, query, or fragment. Since this is itself a valid relative URI, it returns a &RelRef.

pub fn raw_query(&self) -> Option<&'a str>

Returns the escaped substring of the URI that contains the “query”, if present.

See StrExt for details on unescaping the results.

pub fn raw_fragment(&self) -> Option<&'a str>

Returns the escaped substring of the URI that contains the “fragment”, if present.

See UriRawComponents::fragment for the percent-decoded version.

pub fn raw_path_segments(&self) -> impl Iterator<Item = &'a str>

An iterator which returns each individual escaped path item.

See UriRawComponents::path_segments for the percent-decoded version.

pub fn raw_query_items(&self) -> impl Iterator<Item = &'a str>

An iterator which returns each individual escaped query item.

See UriRawComponents::query_items for the percent-decoded version.

pub fn raw_query_key_values(&self) -> impl Iterator<Item = (&'a str, &'a str)>

An iterator which returns each individual escaped query item as a key/value pair. Note that neither are unescaped.

See UriRawComponents::query_key_values for the percent-decoded version.

pub fn fragment(&self) -> Option<Cow<'_, str>>

Unescaped (percent-decoded) version of UriRawComponents::raw_fragment, using std::borrow::Cow<str> instead of &str.

pub fn host(&self) -> Option<Cow<'_, str>>

Unescaped (percent-decoded) version of UriRawComponents::raw_host, using std::borrow::Cow<str> instead of &str.

pub fn authority(&self) -> Option<Cow<'_, str>>

Unescaped (percent-decoded) version of UriRawComponents::raw_authority, using std::borrow::Cow<str> instead of &str.

pub fn userinfo(&self) -> Option<Cow<'_, str>>

Unescaped (percent-decoded) version of UriRawComponents::raw_userinfo, using std::borrow::Cow<str> instead of &str.

pub fn query(&self) -> Option<Cow<'_, str>>

Unescaped (percent-decoded) version of UriRawComponents::raw_query, using std::borrow::Cow<str> instead of &str.

pub fn path_segments(&self) -> impl Iterator<Item = Cow<'_, str>>

Unescaped (percent-decoded) version of UriRawComponents::raw_path_segments, using std::borrow::Cow<str> instead of &str.

pub fn query_items(&self) -> impl Iterator<Item = Cow<'_, str>>

Unescaped (percent-decoded) version of UriRawComponents::raw_query_items, using std::borrow::Cow<str> instead of &str.

pub fn query_key_values( &self, ) -> impl Iterator<Item = (Cow<'_, str>, Cow<'_, str>)>

Unescaped (percent-decoded) version of UriRawComponents::raw_query_key_values, using std::borrow::Cow<str> instead of &str.

pub fn trim_leading_dot_slashes(&self) -> Self

Returns a UriRawComponents with any leading dot-slashes trimmed from the path.

pub fn trim_query(&self) -> Self

Returns a UriRawComponents with the query and fragment cleared.

pub fn trim_fragment(&self) -> Self

Returns a UriRawComponents with the query cleared.

impl<'a> UriRawComponents<'a>

pub unsafe fn from_components_unchecked( scheme: Option<&'a str>, authority: Option<&'a str>, path: &'a str, query: Option<&'a str>, fragment: Option<&'a str>, ) -> UriRawComponents<'a>

Constructs a new UriRawComponents from the given raw, percent-encoded components, without checking that the components are valid.

This method is unsafe because the components are not checked to ensure they are valid.

Trait Implementations

impl AnyUriRef for UriRawComponents<'_>

fn write_to<T: Write + ?Sized>(&self, f: &mut T) -> Result<(), Error>

Note that the implementation of this method for UriRawComponents ignores the value of self.userinfo, self.host, and self.port; instead relying entirely on self.authority.

fn is_empty(&self) -> bool

Returns true if the underlying URI-reference is actually the empty reference.

fn components(&self) -> UriRawComponents<'_>

Returns a UriRawComponents instance which contains all of the components for this URI reference.

fn uri_type(&self) -> UriType

Gets the UriType of the underlying URI-reference.

fn display(&self) -> UriDisplay<'_, Self>

Wraps this AnyUriRef instance in a UriDisplay object for use with formatting macros like write! and format!.

fn to_uri_ref_buf(&self) -> UriRefBuf

Creates a new UriRefBuf from this AnyUriRef.

fn write_resolved<T: Write + ?Sized, D: AnyUriRef + ?Sized>( &self, target: &D, f: &mut T, ) -> Result<(), ResolveError>

Writes out to a core::fmt::Write instance the result of performing URI resolution against target, with self being the base URI.

fn resolved<T: AnyUriRef + ?Sized>( &self, dest: &T, ) -> Result<UriRefBuf, ResolveError>

Creates a new UriRefBuf that contains the result of performing URI resolution with dest.

impl<'a> Clone for UriRawComponents<'a>

fn clone(&self) -> UriRawComponents<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UriRawComponents<'a>

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

Formats the value using the given formatter.

impl Display for UriRawComponents<'_>

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

Formats the value using the given formatter.

impl From<&UriRawComponents<'_>> for String

fn from(comp: &UriRawComponents<'_>) -> Self

Converts to this type from the input type.

impl From<UriRawComponents<'_>> for String

fn from(comp: UriRawComponents<'_>) -> Self

Converts to this type from the input type.

impl<'a> Hash for UriRawComponents<'a>

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<'a> PartialEq for UriRawComponents<'a>

fn eq(&self, other: &UriRawComponents<'a>) -> 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<'a> Copy for UriRawComponents<'a>

impl<'a> Eq for UriRawComponents<'a>

impl<'a> StructuralPartialEq for UriRawComponents<'a>