std::net::IpAddr - Rust
Description: API documentation for the Rust `IpAddr` enum in crate `std`.
Keywords: rust, rustlang, rust-lang, IpAddr

# Enum std::net::IpAddr 1.7.0 [−] [src]

    pub enum IpAddr {
        V4(Ipv4Addr),
        V6(Ipv6Addr),
    }

An IP address, either an IPv4 or IPv6 address.

# Examples

Constructing an IPv4 address:

    use std::net::{IpAddr, Ipv4Addr};

    IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1));Run

Constructing an IPv6 address:

    use std::net::{IpAddr, Ipv6Addr};

    IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));Run

## Variants

`V4(Ipv4Addr)`

Representation of an IPv4 address.

`V6(Ipv6Addr)`

Representation of an IPv6 address.

## Methods

### `impl IpAddr`
[src]

#### `fn is_unspecified(&self) -> bool`
1.12.0

Returns true for the special 'unspecified' address (IPv4, IPv6).

# Examples

    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

    assert_eq!(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)).is_unspecified(), true);
    assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)).is_unspecified(), true);Run

#### `fn is_loopback(&self) -> bool`
1.12.0

Returns true if this is a loopback address (IPv4, IPv6).

# Examples

    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

    assert_eq!(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)).is_loopback(), true);
    assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1)).is_loopback(), true);Run

#### `fn is_global(&self) -> bool`

🔬 This is a nightly-only experimental API. (`ip` #27709)

extra functionality has not been scrutinized to the level that it should be stable

Returns true if the address appears to be globally routable (IPv4, IPv6).

# Examples

    #![feature(ip)]

    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

    fn main() {
        assert_eq!(IpAddr::V4(Ipv4Addr::new(80, 9, 12, 3)).is_global(), true);
        assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1)).is_global(),
                   true);
    }Run

#### `fn is_multicast(&self) -> bool`
1.12.0

Returns true if this is a multicast address (IPv4, IPv6).

# Examples

    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

    assert_eq!(IpAddr::V4(Ipv4Addr::new(224, 254, 0, 0)).is_multicast(), true);
    assert_eq!(IpAddr::V6(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0)).is_multicast(), true);Run

#### `fn is_documentation(&self) -> bool`

🔬 This is a nightly-only experimental API. (`ip` #27709)

extra functionality has not been scrutinized to the level that it should be stable

Returns true if this address is in a range designated for documentation (IPv4, IPv6).

# Examples

    #![feature(ip)]

    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

    fn main() {
        assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_documentation(), true);
        assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0))
                          .is_documentation(), true);
    }Run

#### `fn is_ipv4(&self) -> bool`
1.16.0

Returns true if this address is a valid IPv4 address, false if it's a valid IPv6 address.

# Examples

    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

    fn main() {
        assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_ipv4(), true);
        assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_ipv4(),
                   false);
    }Run

#### `fn is_ipv6(&self) -> bool`
1.16.0

Returns true if this address is a valid IPv6 address, false if it's a valid IPv4 address.

# Examples

    use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

    fn main() {
        assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_ipv6(), false);
        assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_ipv6(),
                   true);
    }Run

## Trait Implementations

### `impl Copy for IpAddr`
[src]

### `impl Clone for IpAddr`
[src]

#### `fn clone(&self) -> IpAddr`

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
1.0.0

Performs copy-assignment from `source`. Read more

### `impl Eq for IpAddr`
[src]

### `impl PartialEq for IpAddr`
[src]

#### `fn eq(&self, __arg_0: &IpAddr) -> bool`

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

#### `fn ne(&self, __arg_0: &IpAddr) -> bool`

This method tests for `!=`.

### `impl Debug for IpAddr`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`

Formats the value using the given formatter.

### `impl Hash for IpAddr`
[src]

#### `fn hash<__H: Hasher>(&self, __arg_0: &mut __H)`

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

### `impl PartialOrd for IpAddr`
[src]

#### `fn partial_cmp(&self, __arg_0: &IpAddr) -> Option<Ordering>`

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

#### `fn lt(&self, __arg_0: &IpAddr) -> bool`

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

#### `fn le(&self, __arg_0: &IpAddr) -> bool`

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

#### `fn gt(&self, __arg_0: &IpAddr) -> bool`

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

#### `fn ge(&self, __arg_0: &IpAddr) -> bool`

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

### `impl Ord for IpAddr`
[src]

#### `fn cmp(&self, __arg_0: &IpAddr) -> Ordering`

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

### `impl Display for IpAddr`
[src]

#### `fn fmt(&self, fmt: &mut Formatter) -> Result`

Formats the value using the given formatter.

### `impl From<Ipv4Addr> for IpAddr`
1.16.0
[src]

#### `fn from(ipv4: Ipv4Addr) -> IpAddr`

Performs the conversion.

### `impl From<Ipv6Addr> for IpAddr`
1.16.0
[src]

#### `fn from(ipv6: Ipv6Addr) -> IpAddr`

Performs the conversion.

### `impl PartialEq<Ipv4Addr> for IpAddr`
1.15.0
[src]

#### `fn eq(&self, other: &Ipv4Addr) -> bool`

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

#### `fn ne(&self, other: &Rhs) -> bool`
1.0.0

This method tests for `!=`.

### `impl PartialOrd<Ipv4Addr> for IpAddr`
1.15.0
[src]

#### `fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering>`

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

#### `fn lt(&self, other: &Rhs) -> bool`
1.0.0

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

#### `fn le(&self, other: &Rhs) -> bool`
1.0.0

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

#### `fn gt(&self, other: &Rhs) -> bool`
1.0.0

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

#### `fn ge(&self, other: &Rhs) -> bool`
1.0.0

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

### `impl PartialEq<Ipv6Addr> for IpAddr`
1.15.0
[src]

#### `fn eq(&self, other: &Ipv6Addr) -> bool`

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

#### `fn ne(&self, other: &Rhs) -> bool`
1.0.0

This method tests for `!=`.

### `impl PartialOrd<Ipv6Addr> for IpAddr`
1.15.0
[src]

#### `fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>`

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

#### `fn lt(&self, other: &Rhs) -> bool`
1.0.0

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

#### `fn le(&self, other: &Rhs) -> bool`
1.0.0

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

#### `fn gt(&self, other: &Rhs) -> bool`
1.0.0

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

#### `fn ge(&self, other: &Rhs) -> bool`
1.0.0

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

### `impl FromStr for IpAddr`
[src]

#### `type Err = AddrParseError`

The associated error which can be returned from parsing.

#### `fn from_str(s: &str) -> Result<IpAddr, AddrParseError>`

Parses a string `s` to return a value of this type. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)