Struct Host 

pub struct Host(pub Host);

Available on crate features http and std only.

Extractor that resolves the hostname of the request.

Tuple Fields

0: Host

Methods from Deref<Target = Host>

pub fn try_as_domain( &self, ) -> Result<Cow<'_, Domain>, Box<dyn Error + Send + Sync>>

Available on crate feature net only.

Returns true if this is the Host::Name variant. View as a Domain, bridging the Uninterpreted variant. Cow::Borrowed for Name; Cow::Owned for an Uninterpreted whose pct-decoded (and IDN-normalized) bytes parse as a domain. Address and IPvFuture-bracketed Uninterpreted fail.

pub fn try_as_ip(&self) -> Result<IpAddr, Box<dyn Error + Send + Sync>>

Available on crate feature net only.

View as an IpAddr, bridging the Uninterpreted variant. Returns the address from Address directly; Uninterpreted succeeds when its pct-decoded bytes parse as an IPv4 or IPv6 address. Name and IPvFuture-bracketed Uninterpreted fail.

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

Available on crate feature net only.

Borrowed view. Same shape as From<&Self> for HostRef but surfaces the borrowed view as an inherent method so call sites don’t need the trait in scope.

pub fn to_str(&self) -> Cow<'_, str>

Available on crate feature net only.

Returns this host as a string. See HostRef::to_str for the borrow / allocation behavior.

pub fn is_empty(&self) -> bool

Available on crate feature net only.

Returns true when this host has an empty textual representation.

This checks the stored representation directly and never formats an IP address or allocates a temporary String.

pub fn as_unicode(&self) -> Cow<'_, str>

Available on crate features idna and net only.

Returns the Unicode (display) form of this host. For named hosts, any xn-- A-labels are inverse-encoded via UTS #46. IP addresses are rendered to their standard textual form.

Cow::Borrowed when no conversion is needed; Cow::Owned for IP addresses and IDN A-labels that actually require decoding.

pub fn is_loopback(&self) -> bool

Available on crate feature net only.

Returns true if this host designates the local machine via loopback. See HostRef::is_loopback for the full contract.

pub const LOCALHOST_IPV4: Host

pub const LOCALHOST_IPV6: Host

pub const LOCALHOST_NAME: Host

pub const DEFAULT_IPV4: Host

pub const DEFAULT_IPV6: Host

pub const BROADCAST_IPV4: Host

pub const EXAMPLE_NAME: Host

Trait Implementations

impl Clone for Host

fn clone(&self) -> Host

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Host

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

Formats the value using the given formatter.

impl Deref for Host

type Target = Host

The resulting type after dereferencing.

fn deref(&self) -> &<Host as Deref>::Target

Dereferences the value.

impl DerefMut for Host

fn deref_mut(&mut self) -> &mut <Host as Deref>::Target

Mutably dereferences the value.

impl<State> FromPartsStateRefPair<State> for Host

where State: Send + Sync,

type Rejection = MissingHost

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_parts_state_ref_pair( parts: &Parts, _state: &State, ) -> Result<Host, <Host as FromPartsStateRefPair<State>>::Rejection>

Perform the extraction.