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

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

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

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

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"));

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]");

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

The owned version of the type.

Converts self into an owned version of itself.

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

This method tests for !=.

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

This method tests for !=.

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

This method tests for !=.

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

This method tests for !=.

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

This method tests for !=.

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

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Compare self to key and return true if they are equal.

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

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

Converts self into a collection.

Should always be Self

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more