# url::Host - Rust
API documentation for the Rust `Host` enum in crate `url`.
Keywords: rust, rustlang, rust-lang, Host

# Enum url::Host [−] [src]

    pub enum Host<S = String> {
        Domain(S),
        Ipv4(Ipv4Addr),
        Ipv6(Ipv6Addr),
    }

The host name of an URL.

## Variants

`Domain(S)`

A DNS domain name, as '.' dot-separated labels. Non-ASCII labels are encoded in punycode per IDNA if this is the host of a special URL, or percent encoded for non-special URLs. Hosts for non-special URLs are also called opaque hosts.

`Ipv4(Ipv4Addr)`

An IPv4 address. `Url::host_str` returns the serialization of this address, as four decimal integers separated by `.` dots.

`Ipv6(Ipv6Addr)`

An IPv6 address. `Url::host_str` returns the serialization of that address between `[` and `]` brackets, in the format per RFC 5952 A Recommendation for IPv6 Address Text Representation: lowercase hexadecimal with maximal `::` compression.

## Implementations

### `impl<'a> Host<&'a str>` [src]

#### `pub fn to_owned(&self) -> Host<String>` [src]

Return a copy of `self` that owns an allocated `String` but does not borrow an `&Url`.

### `impl Host<String>` [src]

#### `pub fn parse(input: &str) -> Result<Self, ParseError>` [src]

Parse a host: either an IPv6 address in [] square brackets, or a domain.

https://url.spec.whatwg.org/#host-parsing

#### `pub fn parse_opaque(input: &str) -> Result<Self, ParseError>` [src]

## Trait Implementations

### `impl<S: Clone> Clone for Host<S>` [src]

#### `fn clone(&self) -> Host<S>` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl<S: Debug> Debug for Host<S>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<S: AsRef<str>> Display for Host<S>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<S: Eq> Eq for Host<S>` [src]

### `impl<S: Hash> Hash for Host<S>` [src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)` [src]

Feeds this value into the given `Hasher`. Read more

#### `pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0 [src]

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

### `impl<S: Ord> Ord for Host<S>` [src]

#### `fn cmp(&self, other: &Host<S>) -> Ordering` [src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]pub fn max(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]pub fn min(self, other: Self) -> Self` 1.21.0 [src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self` 1.50.0 [src]

Restrict a value to a certain interval. Read more

### `impl<S, T> PartialEq<Host<T>> for Host<S> where
S: PartialEq<T>,` [src]

#### `fn eq(&self, other: &Host<T>) -> bool` [src]

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

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

### `impl<S: PartialOrd> PartialOrd<Host<S>> for Host<S>` [src]

#### `fn partial_cmp(&self, other: &Host<S>) -> Option<Ordering>` [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `fn lt(&self, other: &Host<S>) -> bool` [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Host<S>) -> bool` [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn gt(&self, other: &Host<S>) -> bool` [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

#### `fn ge(&self, other: &Host<S>) -> bool` [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

### `impl<S> StructuralEq for Host<S>` [src]

## Auto Trait Implementations

### `impl<S> RefUnwindSafe for Host<S> where
S: RefUnwindSafe,` [src]

### `impl<S> Send for Host<S> where
S: Send,` [src]

### `impl<S> Sync for Host<S> where
S: Sync,` [src]

### `impl<S> Unpin for Host<S> where
S: Unpin,` [src]

### `impl<S> UnwindSafe for Host<S> where
S: UnwindSafe,` [src]

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

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

recently added

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

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String` [src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.