Enum rocket::http::uri::Uri

pub enum Uri<'a> {
    Origin(Origin<'a>),
    Authority(Authority<'a>),
    Absolute(Absolute<'a>),
    Asterisk,
}
Expand description

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.

§

Asterisk

An asterisk: exactly *.

Implementations§

§

impl<'a> Uri<'a>

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

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>>

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>>

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>>

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>

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>

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>

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>

§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl<'a> Debug for Uri<'a>

§

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

Formats the value using the given formatter. Read more
§

impl<'a> Display for Uri<'a>

§

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

Formats the value using the given formatter. Read more
§

impl<'a> From<Absolute<'a>> for Uri<'a>

§

fn from(other: Absolute<'a>) -> Uri<'a>

Converts to this type from the input type.
§

impl<'a> From<Authority<'a>> for Uri<'a>

§

fn from(other: Authority<'a>) -> Uri<'a>

Converts to this type from the input type.
§

impl<'a> From<Origin<'a>> for Uri<'a>

§

fn from(other: Origin<'a>) -> Uri<'a>

Converts to this type from the input type.
§

impl<'a> IntoOwned for Uri<'a>

§

type Owned = Uri<'static>

The owned version of the type.
§

fn into_owned(self) -> Uri<'static>

Converts self into an owned version of itself.
§

impl<'a> PartialEq for Uri<'a>

§

fn eq(&self, other: &Uri<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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> TryFrom<&'a str> for Uri<'a>

§

type Error = Error<'a>

The type returned in the event of a conversion error.
§

fn try_from( string: &'a str, ) -> Result<Uri<'a>, <Uri<'a> as TryFrom<&'a str>>::Error>

Performs the conversion.
§

impl TryFrom<String> for Uri<'static>

§

type Error = Error<'static>

The type returned in the event of a conversion error.
§

fn try_from( string: String, ) -> Result<Uri<'static>, <Uri<'static> as TryFrom<String>>::Error>

Performs the conversion.
§

impl<'a> StructuralPartialEq for Uri<'a>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn as_result(self) -> Result<T, ParseErr<I>>

source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Typeable for T
where T: Any,

source§

fn get_type(&self) -> TypeId

Get the TypeId of this object.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V