Struct rocket::http::uri::Authority

pub struct Authority<'a> { /* fields omitted */ }

A URI with an authority only: user:pass@host:8000.

Structure

The following diagram illustrates the syntactic structure of an authority URI:

username:password@some.host:8088
|---------------| |-------| |--|
    user info        host   port

Only the host part of the URI is required.

Implementations

impl<'a> Authority<'a>

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

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

Example

use rocket::http::uri::Authority;

// Parse a valid authority URI.
let uri = Authority::parse("user:pass@host").expect("valid URI");
assert_eq!(uri.user_info(), Some("user:pass"));
assert_eq!(uri.host(), "host");
assert_eq!(uri.port(), None);

// Invalid authority URIs fail to parse.
Authority::parse("http://google.com").expect_err("invalid authority");

pub fn user_info(&self) -> Option<&str>

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

Example

use rocket::http::uri::Authority;

let uri = Authority::parse("username:password@host").unwrap();
assert_eq!(uri.user_info(), Some("username:password"));

pub fn host(&self) -> &str

Returns the host part of the authority URI.

If the host was provided in brackets (such as for IPv6 addresses), the brackets will not be part of the returned string.

Example

use rocket::http::uri::Authority;

let uri = Authority::parse("domain.com:123").unwrap();
assert_eq!(uri.host(), "domain.com");

let uri = Authority::parse("username:password@host:123").unwrap();
assert_eq!(uri.host(), "host");

let uri = Authority::parse("username:password@[1::2]:123").unwrap();
assert_eq!(uri.host(), "1::2");

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

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

Example

use rocket::http::uri::Authority;

// With a port.
let uri = Authority::parse("username:password@host:123").unwrap();
assert_eq!(uri.port(), Some(123));

let uri = Authority::parse("domain.com:8181").unwrap();
assert_eq!(uri.port(), Some(8181));

// Without a port.
let uri = Authority::parse("username:password@host").unwrap();
assert_eq!(uri.port(), None);

Trait Implementations

impl<'a> Clone for Authority<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Authority<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Authority<'a>

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<'a> IntoOwned for Authority<'a>

type Owned = Authority<'static>

The owned version of the type.

pub fn into_owned(self) -> Authority<'static>

Converts self into an owned version of itself.

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

pub fn eq(&self, other: &Authority<'b>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.