[][src]Enum rocket_http::uri::Uri

pub enum Uri<'a> {

An enum encapsulating any of the possible URI variants.


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.


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().



An origin URI.


An authority URI.


An absolute URI.


An asterisk: exactly *.


impl<'a> Uri<'a>[src]

pub fn parse(string: &'a str) -> Result<Uri<'a>, Error>[src]

Parses the string string into a Uri. Parsing will never allocate. Returns an Error if string is not a valid URI.


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.


use rocket::http::uri::Uri;

let uri = Uri::parse("/a/b/c?query").expect("valid URI");

let uri = Uri::parse("http://google.com").expect("valid URI");

pub fn authority(&self) -> Option<&Authority<'a>>[src]

Returns the internal instance of Authority if self is a Uri::Authority. Otherwise, returns None.


use rocket::http::uri::Uri;

let uri = Uri::parse("user:pass@domain.com").expect("valid URI");

let uri = Uri::parse("http://google.com").expect("valid URI");

pub fn absolute(&self) -> Option<&Absolute<'a>>[src]

Returns the internal instance of Absolute if self is a Uri::Absolute. Otherwise, returns None.


use rocket::http::uri::Uri;

let uri = Uri::parse("http://google.com").expect("valid URI");

let uri = Uri::parse("/path").expect("valid URI");

pub fn percent_encode(string: &str) -> Cow<str>[src]

Returns a URL-encoded version of the string. Any reserved characters are percent-encoded.


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.


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.


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> IntoOwned for Uri<'a>[src]

type Owned = Uri<'static>

The owned version of the type.

impl<'a> PartialEq<Uri<'a>> for Uri<'a>[src]

impl<'a> From<Origin<'a>> for Uri<'a>[src]

impl<'a> From<Authority<'a>> for Uri<'a>[src]

impl<'a> From<Absolute<'a>> for Uri<'a>[src]

impl<'a> Clone for Uri<'a>[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'a> Debug for Uri<'a>[src]

impl<'a> Display 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.

impl TryFrom<String> for Uri<'static>[src]

type Error = Error<'static>

The type returned in the event of a conversion error.

Auto Trait Implementations

impl<'a> Send for Uri<'a>

impl<'a> Unpin for Uri<'a>

impl<'a> Sync for Uri<'a>

impl<'a> UnwindSafe for Uri<'a>

impl<'a> !RefUnwindSafe for Uri<'a>

Blanket Implementations

impl<T> IntoCollection<T> for T[src]

impl<T> ToString for T where
    T: Display + ?Sized

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized

impl<T, I> AsResult<T, I> for T where
    I: Input

impl<T> Typeable for T where
    T: Any

fn get_type(&self) -> TypeId

Get the TypeId of this object.