Enum rocket::http::uri::Uri [−][src]
An enum
encapsulating any of the possible URI variants.
Usage
In Rocket, this type will rarely be used directly. Instead, you will
typically encounter URIs via the Origin
type. This is because all
incoming requests contain origin-type URIs.
Nevertheless, the Uri
type is typically enountered as a conversion target.
In particular, you will likely see generic bounds of the form: T: TryInto<Uri>
(for instance, in Redirect
methods). This means that you can provide any type T
that implements
TryInto<Uri>
, or, equivalently, any type U
for which Uri
implements
TryFrom<U>
or From<U>
. These include &str
and String
, Origin
,
Authority
, and Absolute
.
Parsing
The Uri
type implements a full, zero-allocation, zero-copy RFC 7230
compliant parser. To parse an &str
into a Uri
, use the Uri::parse()
method. Alternatively, you may also use the TryFrom<&str>
and
TryFrom<String>
trait implementation. To inspect the parsed type, match on
the resulting enum
and use the methods of the internal structure.
Percent Encoding/Decoding
This type also provides the following percent encoding/decoding helper
methods: Uri::percent_encode()
, Uri::percent_decode()
, and
Uri::percent_decode_lossy()
.
Variants
Origin(Origin<'a>)
An origin URI.
Authority(Authority<'a>)
An authority URI.
Absolute(Absolute<'a>)
An absolute URI.
An asterisk: exactly *
.
Implementations
impl<'a> Uri<'a>
[src]
pub fn parse(string: &'a str) -> Result<Uri<'a>, Error<'a>>
[src]
Parses the string string
into a Uri
. Parsing will never allocate.
Returns an Error
if string
is not a valid URI.
Example
use rocket::http::uri::Uri; // Parse a valid origin URI (note: in practice, use `Origin::parse()`). let uri = Uri::parse("/a/b/c?query").expect("valid URI"); let origin = uri.origin().expect("origin URI"); assert_eq!(origin.path(), "/a/b/c"); assert_eq!(origin.query(), Some("query")); // Invalid URIs fail to parse. Uri::parse("foo bar").expect_err("invalid URI");
pub fn origin(&self) -> Option<&Origin<'a>>
[src]
Returns the internal instance of Origin
if self
is a Uri::Origin
.
Otherwise, returns None
.
Example
use rocket::http::uri::Uri; let uri = Uri::parse("/a/b/c?query").expect("valid URI"); assert!(uri.origin().is_some()); let uri = Uri::parse("http://google.com").expect("valid URI"); assert!(uri.origin().is_none());
pub fn authority(&self) -> Option<&Authority<'a>>
[src]
Returns the internal instance of Authority
if self
is a
Uri::Authority
. Otherwise, returns None
.
Example
use rocket::http::uri::Uri; let uri = Uri::parse("user:pass@domain.com").expect("valid URI"); assert!(uri.authority().is_some()); let uri = Uri::parse("http://google.com").expect("valid URI"); assert!(uri.authority().is_none());
pub fn absolute(&self) -> Option<&Absolute<'a>>
[src]
Returns the internal instance of Absolute
if self
is a
Uri::Absolute
. Otherwise, returns None
.
Example
use rocket::http::uri::Uri; let uri = Uri::parse("http://google.com").expect("valid URI"); assert!(uri.absolute().is_some()); let uri = Uri::parse("/path").expect("valid URI"); assert!(uri.absolute().is_none());
pub fn percent_encode(string: &str) -> Cow<'_, str>
[src]
Returns a URL-encoded version of the string. Any reserved characters are percent-encoded.
Examples
use rocket::http::uri::Uri; let encoded = Uri::percent_encode("hello?a=<b>hi</b>"); assert_eq!(encoded, "hello%3Fa%3D%3Cb%3Ehi%3C%2Fb%3E");
pub fn percent_decode(string: &[u8]) -> Result<Cow<'_, str>, Utf8Error>
[src]
Returns a URL-decoded version of the string. If the percent encoded
values are not valid UTF-8, an Err
is returned.
Examples
use rocket::http::uri::Uri; let decoded = Uri::percent_decode("/Hello%2C%20world%21".as_bytes()); assert_eq!(decoded.unwrap(), "/Hello, world!");
pub fn percent_decode_lossy(string: &[u8]) -> Cow<'_, str>
[src]
Returns a URL-decoded version of the path. Any invalid UTF-8 percent-encoded byte sequences will be replaced � U+FFFD, the replacement character.
Examples
use rocket::http::uri::Uri; let decoded = Uri::percent_decode_lossy("/Hello%2C%20world%21".as_bytes()); assert_eq!(decoded, "/Hello, world!");
Trait Implementations
impl<'a> Clone for Uri<'a>
[src]
impl<'a> Debug for Uri<'a>
[src]
impl<'a> Display for Uri<'a>
[src]
impl<'a> From<Absolute<'a>> for Uri<'a>
[src]
impl<'a> From<Authority<'a>> for Uri<'a>
[src]
impl<'a> From<Origin<'a>> for Uri<'a>
[src]
impl<'a> IntoOwned for Uri<'a>
[src]
type Owned = Uri<'static>
The owned version of the type.
pub fn into_owned(self) -> Uri<'static>
[src]
impl<'a> PartialEq<Uri<'a>> for Uri<'a>
[src]
impl<'a> StructuralPartialEq for Uri<'a>
[src]
impl<'a> TryFrom<&'a str> for Uri<'a>
[src]
type Error = Error<'a>
The type returned in the event of a conversion error.
pub fn try_from(
string: &'a str
) -> Result<Uri<'a>, <Uri<'a> as TryFrom<&'a str>>::Error>
[src]
string: &'a str
) -> Result<Uri<'a>, <Uri<'a> as TryFrom<&'a str>>::Error>
impl TryFrom<String> for Uri<'static>
[src]
Auto Trait Implementations
impl<'a> !RefUnwindSafe for Uri<'a>
[src]
impl<'a> Send for Uri<'a>
[src]
impl<'a> Sync for Uri<'a>
[src]
impl<'a> Unpin for Uri<'a>
[src]
impl<'a> UnwindSafe for Uri<'a>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T, I> AsResult<T, I> for T where
I: Input,
[src]
I: Input,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IntoCollection<T> for T
[src]
pub fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
[src]
A: Array<Item = T>,
pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,
[src]
F: FnMut(T) -> U,
A: Array<Item = U>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Typeable for T where
T: Any,
T: Any,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,