Struct Authority

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

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.

(De)serialization

Authority is both Serialize and Deserialize:

use serde::{Serialize, Deserialize};
use rocket::http::uri::Authority;

#[derive(Deserialize, Serialize)]
struct UriOwned {
    uri: Authority<'static>,
}

#[derive(Deserialize, Serialize)]
struct UriBorrowed<'a> {
    uri: Authority<'a>,
}

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("https://rocket.rs").expect_err("invalid authority");

// Prefer to use `uri!()` when the input is statically known:
let uri = uri!("user:pass@host");
assert_eq!(uri.user_info(), Some("user:pass"));
assert_eq!(uri.host(), "host");
assert_eq!(uri.port(), None);

pub fn parse_owned(string: String) -> Result<Authority<'static>, Error<'static>>

Parses the string string into an Authority. Parsing never allocates on success. May allocate on error.

This method should be used instead of Authority::parse() when the source URI is already a String. Returns an Error if string is not a valid authority URI.

Example

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

let source = format!("rocket.rs:8000");
let uri = Authority::parse_owned(source).expect("valid URI");
assert!(uri.user_info().is_none());
assert_eq!(uri.host(), "rocket.rs");
assert_eq!(uri.port(), Some(8000));

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

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

Example

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

pub fn host(&self) -> &str

Returns the host part of the authority URI.

Example

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

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

let uri = uri!("username:password@[1::2]:123");
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

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

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

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

Trait Implementations

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

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>

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

Formats the value using the given formatter.

impl<'a, 'de> Deserialize<'de> for Authority<'a>

fn deserialize<D>( deserializer: D, ) -> Result<Authority<'a>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Authority<'_>

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

Formats the value using the given formatter.

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

fn from(auth: Authority<'a>) -> Host<'a>

Converts to this type from the input type.

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

fn from(authority: Authority<'a>) -> Reference<'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 Hash for Authority<'_>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoOwned for Authority<'_>

type Owned = Authority<'static>

The owned version of the type.

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

Converts self into an owned version of itself.

impl PartialEq<&str> for Authority<'_>

fn eq(&self, other: &&str) -> bool

Tests for self and other values to be equal, and is used by ==.

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 PartialEq<Authority<'_>> for str

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

Tests for self and other values to be equal, and is used by ==.

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<'b, 'a> PartialEq<Authority<'a>> for Uri<'b>

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

Tests for self and other values to be equal, and is used by ==.

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, 'b> PartialEq<Authority<'b>> for Authority<'a>

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

Tests for self and other values to be equal, and is used by ==.

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<'b, 'a> PartialEq<Uri<'b>> for Authority<'a>

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq<str> for Authority<'_>

fn eq(&self, string: &str) -> bool

Tests for self and other values to be equal, and is used by ==.

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> Serialize for Authority<'a>

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a String> for Authority<'a>

type Error = Error<'a>

The type returned in the event of a conversion error.

fn try_from( value: &'a String, ) -> Result<Authority<'a>, <Authority<'a> as TryFrom<&'a String>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for Authority<'a>

type Error = Error<'a>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Authority<'static>

type Error = Error<'static>

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromUriError

The type returned in the event of a conversion error.

fn try_from( uri: Uri<'a>, ) -> Result<Authority<'a>, <Authority<'a> as TryFrom<Uri<'a>>>::Error>

Performs the conversion.

impl Eq for Authority<'_>