rama::net::address

Struct Authority

pub struct Authority {
    pub user_info: Option<UserInfo>,
    pub address: HostWithOptPort,
}

Available on crate feature net only.

Expand description

A Host with optionally a port and/or user-info (UserInfo).

user_info is the raw RFC 3986 §3.2.1 view (opaque bytes). For HTTP Basic-Auth interop call UserInfo::to_basic on it.

Planned migration: in a follow-up PR after the URI work, when rama’s Basic is relaxed to allow empty usernames (per RFC 7617 §2), the intent is to replace Option<UserInfo> here with Option<Basic>. See the user_info module docs for the rationale.

§Examples

example.com
127.0.0.1
example.com:80
127.0.0.1:80
joe@example.com:80
joe:secret@example.com

Fields§

§user_info: Option<UserInfo>§address: HostWithOptPort

Implementations§

§

impl Authority

pub const fn new(addr: HostWithOptPort) -> Authority

Creates a new Authority from a HostWithOptPort.

pub fn new_with_user_info( addr: HostWithOptPort, user_info: UserInfo, ) -> Authority

Creates a new Authority from a HostWithOptPort and user-info (UserInfo).

Not const fn — UserInfo wraps Bytes which has no const constructor; use the builder (Self::with_user_info) plus UserInfo::from_static for the const-friendly path.

pub const fn from_static(s: &'static str) -> Authority

Compile-time constructor for a domain-only Authority (no user-info, no explicit port). Panics at compile time when s isn’t a valid domain.

pub const fn local_ipv4() -> Authority

creates a new local ipv4 Authority without a port.

§Example

use rama_net::address::Authority;

let addr = Authority::local_ipv4();
assert_eq!("127.0.0.1", addr.to_string());

pub const fn local_ipv4_with_port(port: u16) -> Authority

creates a new local ipv4 Authority with the given port

§Example

use rama_net::address::Authority;

let addr = Authority::local_ipv4_with_port(8080);
assert_eq!("127.0.0.1:8080", addr.to_string());

pub const fn local_ipv6() -> Authority

creates a new local ipv6 Authority without a port.

§Example

IPv6 addresses always render with […] brackets even with no port — see HostWithOptPort’s Display impl for the rationale.

use rama_net::address::Authority;

let addr = Authority::local_ipv6();
assert_eq!("[::1]", addr.to_string());

pub const fn local_ipv6_with_port(port: u16) -> Authority

creates a new local ipv6 Authority with the given port.

§Example

use rama_net::address::Authority;

let addr = Authority::local_ipv6_with_port(8080);
assert_eq!("[::1]:8080", addr.to_string());

pub const fn default_ipv4() -> Authority

creates a default ipv4 Authority without a port

§Example

use rama_net::address::Authority;

let addr = Authority::default_ipv4_with_port(8080);
assert_eq!("0.0.0.0:8080", addr.to_string());

pub const fn default_ipv4_with_port(port: u16) -> Authority

creates a default ipv4 Authority with the given port

§Example

use rama_net::address::Authority;

let addr = Authority::default_ipv4_with_port(8080);
assert_eq!("0.0.0.0:8080", addr.to_string());

pub const fn default_ipv6() -> Authority

creates a new default ipv6 Authority without a port.

IPv6 addresses always render with […] brackets even with no port — see HostWithOptPort’s Display impl for the rationale.

§Example

use rama_net::address::Authority;

let addr = Authority::default_ipv6();
assert_eq!("[::]", addr.to_string());

pub const fn default_ipv6_with_port(port: u16) -> Authority

creates a new default ipv6 Authority with the given port.

§Example

use rama_net::address::Authority;

let addr = Authority::default_ipv6_with_port(8080);
assert_eq!("[::]:8080", addr.to_string());

pub const fn broadcast_ipv4() -> Authority

creates a new broadcast ipv4 Authority without a port

§Example

use rama_net::address::Authority;

let addr = Authority::broadcast_ipv4();
assert_eq!("255.255.255.255", addr.to_string());

pub const fn broadcast_ipv4_with_port(port: u16) -> Authority

creates a new broadcast ipv4 Authority with the given port

§Example

use rama_net::address::Authority;

let addr = Authority::broadcast_ipv4_with_port(8080);
assert_eq!("255.255.255.255:8080", addr.to_string());

pub const fn example_domain() -> Authority

Creates a new example domain Authority without a port.

pub const fn example_domain_http() -> Authority

Creates a new example domain HostWithOptPort for the http default port.

pub const fn example_domain_https() -> Authority

Creates a new example domain HostWithOptPort for the https default port.

pub const fn example_domain_with_port(port: u16) -> Authority

Creates a new example domain HostWithOptPort for the given port.

pub const fn localhost_domain() -> Authority

Creates a new localhost domain HostWithOptPort without a port.

pub const fn localhost_domain_http() -> Authority

Creates a new localhost domain HostWithOptPort for the http default port.

pub const fn localhost_domain_https() -> Authority

Creates a new localhost domain HostWithOptPort for the https default port.

pub const fn localhost_domain_with_port(port: u16) -> Authority

Creates a new localhost domain HostWithOptPort for the given port.

pub fn with_host(self, host: impl Into<Host>) -> Authority

Set Host of Authority. Accepts any Into<Host> — Domain, IpAddr, and so on.

pub fn set_host(&mut self, host: impl Into<Host>) -> &mut Authority

Set Host of Authority. Accepts any Into<Host> — Domain, IpAddr, and so on.

pub fn with_port(self, port: impl Into<OptPort>) -> Authority

Set the port of Authority. Accepts u16, OptPort, or Option<u16> via Into<OptPort>. Pass OptPort::Unset to clear.

pub fn set_port(&mut self, port: impl Into<OptPort>) -> &mut Authority

Set the port of Authority. Accepts u16, OptPort, or Option<u16> via Into<OptPort>. Pass OptPort::Unset to clear.

pub const fn port_u16(&self) -> Option<u16>

Relaxed view of the port — Set(n) → Some(n), everything else None. Use when the Unset vs Empty distinction doesn’t matter.

pub fn maybe_with_user_info(self, user_info: Option<UserInfo>) -> Authority

(un)set user-info (UserInfo) of Authority

pub fn maybe_set_user_info( &mut self, user_info: Option<UserInfo>, ) -> &mut Authority

(un)set user-info (UserInfo) of Authority

pub fn with_user_info(self, user_info: UserInfo) -> Authority

(un)set user-info (UserInfo) of Authority

pub fn set_user_info(&mut self, user_info: UserInfo) -> &mut Authority

(un)set user-info (UserInfo) of Authority

pub fn without_user_info(self) -> Authority

(un)set user-info (UserInfo) of Authority

pub fn unset_user_info(&mut self) -> &mut Authority

(un)set user-info (UserInfo) of Authority

pub fn view(&self) -> AuthorityRef<'_>

Borrowed view.

Trait Implementations§

§

impl Clone for Authority

§

fn clone(&self) -> Authority

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for Authority

§

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

Formats the value using the given formatter. Read more

§

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

§

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

Deserialize this value from the given Serde deserializer. Read more

§

impl Display for Authority

§

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

Formats the value using the given formatter. Read more

§