Struct rocket::http::uri::Absolute

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

A URI with a scheme, authority, path, and query: http://user:pass@domain.com:4444/path?query.

Structure

The following diagram illustrates the syntactic structure of an absolute URI with all optional parts:

 http://user:pass@domain.com:4444/path?query
 |--|   |-----------------------||---------|
scheme          authority          origin

The scheme part of the absolute URI and at least one of authority or origin are required.

Implementations

impl<'a> Absolute<'a>

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

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

Example

use rocket::http::uri::Absolute;

// Parse a valid authority URI.
let uri = Absolute::parse("http://google.com").expect("valid URI");
assert_eq!(uri.scheme(), "http");
assert_eq!(uri.authority().unwrap().host(), "google.com");
assert_eq!(uri.origin(), None);

pub fn scheme(&self) -> &str

Returns the scheme part of the absolute URI.

Example

use rocket::http::uri::Absolute;

let uri = Absolute::parse("ftp://127.0.0.1").expect("valid URI");
assert_eq!(uri.scheme(), "ftp");

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

Returns the authority part of the absolute URI, if there is one.

Example

use rocket::http::uri::Absolute;

let uri = Absolute::parse("https://rocket.rs:80").expect("valid URI");
assert_eq!(uri.scheme(), "https");
let authority = uri.authority().unwrap();
assert_eq!(authority.host(), "rocket.rs");
assert_eq!(authority.port(), Some(80));

let uri = Absolute::parse("file:/web/home").expect("valid URI");
assert_eq!(uri.authority(), None);

pub fn origin(&self) -> Option<&Origin<'a>>

Returns the origin part of the absolute URI, if there is one.

Example

use rocket::http::uri::Absolute;

let uri = Absolute::parse("file:/web/home.html?new").expect("valid URI");
assert_eq!(uri.scheme(), "file");
let origin = uri.origin().unwrap();
assert_eq!(origin.path(), "/web/home.html");
assert_eq!(origin.query(), Some("new"));

let uri = Absolute::parse("https://rocket.rs").expect("valid URI");
assert_eq!(uri.origin(), None);

Trait Implementations

impl<'a> Clone for Absolute<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Absolute<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Absolute<'a>

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

Formats the value using the given formatter.

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> IntoOwned for Absolute<'a>

type Owned = Absolute<'static>

The owned version of the type.

fn into_owned(self) -> <Absolute<'a> as IntoOwned>::Owned

Converts self into an owned version of itself.

impl<'a, 'b> PartialEq<Absolute<'b>> for Absolute<'a>

fn eq(&self, other: &Absolute<'b>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.