# Enum std::net::IpAddr

1.7.0 · source ·

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

Expand description

An IP address, either IPv4 or IPv6.

This enum can contain either an `Ipv4Addr` or an `Ipv6Addr`, see their respective documentation for more details.

## Examples

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

    let localhost_v4 = IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1));
    let localhost_v6 = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));

    assert_eq!("127.0.0.1".parse(), Ok(localhost_v4));
    assert_eq!("::1".parse(), Ok(localhost_v6));

    assert_eq!(localhost_v4.is_ipv6(), false);
    assert_eq!(localhost_v4.is_ipv4(), true);

Run

## Variants§

§

### V4(Ipv4Addr)

An IPv4 address.

§

### V6(Ipv6Addr)

An IPv6 address.

## Implementations§

source§

### impl IpAddr

1.12.0 (const: 1.50.0) · source

#### pub const fn is_unspecified(&self) -> bool

Returns `true` for the special ‘unspecified’ address.

See the documentation for `Ipv4Addr::is_unspecified()` and `Ipv6Addr::is_unspecified()` for more details.

##### 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
1.12.0 (const: 1.50.0) · source

#### pub const fn is_loopback(&self) -> bool

Returns `true` if this is a loopback address.

See the documentation for `Ipv4Addr::is_loopback()` and `Ipv6Addr::is_loopback()` for more details.

##### 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
const: unstable · source

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

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

Returns `true` if the address appears to be globally routable.

See the documentation for `Ipv4Addr::is_global()` and `Ipv6Addr::is_global()` for more details.

##### Examples

    #![feature(ip)]

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

    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
1.12.0 (const: 1.50.0) · source

#### pub const fn is_multicast(&self) -> bool

Returns `true` if this is a multicast address.

See the documentation for `Ipv4Addr::is_multicast()` and `Ipv6Addr::is_multicast()` for more details.

##### 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
const: unstable · source

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

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

Returns `true` if this address is in a range designated for documentation.

See the documentation for `Ipv4Addr::is_documentation()` and `Ipv6Addr::is_documentation()` for more details.

##### Examples

    #![feature(ip)]

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

    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
source

#### pub const fn is_benchmarking(&self) -> bool

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

Returns `true` if this address is in a range designated for benchmarking.

See the documentation for `Ipv4Addr::is_benchmarking()` and `Ipv6Addr::is_benchmarking()` for more details.

##### Examples

    #![feature(ip)]

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

    assert_eq!(IpAddr::V4(Ipv4Addr::new(198, 19, 255, 255)).is_benchmarking(), true);
    assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0x2, 0, 0, 0, 0, 0, 0)).is_benchmarking(), true);

Run
1.16.0 (const: 1.50.0) · source

#### pub const fn is_ipv4(&self) -> bool

Returns `true` if this address is an `IPv4` address, and `false` otherwise.

##### Examples

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

    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
1.16.0 (const: 1.50.0) · source

#### pub const fn is_ipv6(&self) -> bool

Returns `true` if this address is an `IPv6` address, and `false` otherwise.

##### Examples

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

    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
1.75.0 (const: 1.75.0) · source

#### pub const fn to_canonical(&self) -> IpAddr

Converts this address to an `IpAddr::V4` if it is an IPv4-mapped IPv6 addresses, otherwise it return `self` as-is.

##### Examples

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

    let localhost_v4 = Ipv4Addr::new(127, 0, 0, 1);

    assert_eq!(IpAddr::V4(localhost_v4).to_canonical(), localhost_v4);
    assert_eq!(IpAddr::V6(localhost_v4.to_ipv6_mapped()).to_canonical(), localhost_v4);
    assert_eq!(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)).to_canonical().is_loopback(), true);
    assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x7f00, 0x1)).is_loopback(), false);
    assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x7f00, 0x1)).to_canonical().is_loopback(), true);

Run
source§

### impl IpAddr

source

#### pub fn parse_ascii(b: &[u8]) -> Result<IpAddr, AddrParseError>

🔬This is a nightly-only experimental API. (`addr_parse_ascii` #101035)

Parse an IP address from a slice of bytes.

    #![feature(addr_parse_ascii)]

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

    let localhost_v4 = IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1));
    let localhost_v6 = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));

    assert_eq!(IpAddr::parse_ascii(b"127.0.0.1"), Ok(localhost_v4));
    assert_eq!(IpAddr::parse_ascii(b"::1"), Ok(localhost_v6));

Run

## Trait Implementations§

source§

### impl Clone for IpAddr

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for IpAddr

source§

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

Formats the value using the given formatter. Read more
source§

### impl Display for IpAddr

source§

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

Formats the value using the given formatter. Read more
1.17.0 · source§

### impl From<[u16; 8]> for IpAddr

source§

#### fn from(segments: [u16; 8]) -> IpAddr

Creates an `IpAddr::V6` from an eight element 16-bit array.

##### Examples

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

    let addr = IpAddr::from([
        525u16, 524u16, 523u16, 522u16,
        521u16, 520u16, 519u16, 518u16,
    ]);
    assert_eq!(
        IpAddr::V6(Ipv6Addr::new(
            0x20d, 0x20c,
            0x20b, 0x20a,
            0x209, 0x208,
            0x207, 0x206
        )),
        addr
    );

Run
1.17.0 · source§

### impl From<[u8; 16]> for IpAddr

source§

#### fn from(octets: [u8; 16]) -> IpAddr

Creates an `IpAddr::V6` from a sixteen element byte array.

##### Examples

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

    let addr = IpAddr::from([
        25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
        17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
    ]);
    assert_eq!(
        IpAddr::V6(Ipv6Addr::new(
            0x1918, 0x1716,
            0x1514, 0x1312,
            0x1110, 0x0f0e,
            0x0d0c, 0x0b0a
        )),
        addr
    );

Run
1.17.0 · source§

### impl From<[u8; 4]> for IpAddr

source§

#### fn from(octets: [u8; 4]) -> IpAddr

Creates an `IpAddr::V4` from a four element byte array.

##### Examples

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

    let addr = IpAddr::from([13u8, 12u8, 11u8, 10u8]);
    assert_eq!(IpAddr::V4(Ipv4Addr::new(13, 12, 11, 10)), addr);

Run
1.16.0 · source§

### impl From<Ipv4Addr> for IpAddr

source§

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

Copies this address to a new `IpAddr::V4`.

##### Examples

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

    let addr = Ipv4Addr::new(127, 0, 0, 1);

    assert_eq!(
        IpAddr::V4(addr),
        IpAddr::from(addr)
    )

Run
1.16.0 · source§

### impl From<Ipv6Addr> for IpAddr

source§

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

Copies this address to a new `IpAddr::V6`.

##### Examples

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

    let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);

    assert_eq!(
        IpAddr::V6(addr),
        IpAddr::from(addr)
    );

Run
source§

### impl FromStr for IpAddr

§

#### type Err = AddrParseError

The associated error which can be returned from parsing.
source§

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

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

### impl Hash for IpAddr

source§

#### fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given `Hasher`. Read more
1.3.0 · source§

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

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

### impl Ord for IpAddr

source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · source§

#### fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

#### fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

#### fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
1.16.0 · source§

### impl PartialEq<IpAddr> for Ipv4Addr

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0 · source§

### impl PartialEq<IpAddr> for Ipv6Addr

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0 · source§

### impl PartialEq<Ipv4Addr> for IpAddr

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0 · source§

### impl PartialEq<Ipv6Addr> for IpAddr

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl PartialEq for IpAddr

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0 · source§

### impl PartialOrd<IpAddr> for Ipv4Addr

source§

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

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

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

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

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

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

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

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

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

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

### impl PartialOrd<IpAddr> for Ipv6Addr

source§

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

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

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

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

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

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

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

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

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

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

### impl PartialOrd<Ipv4Addr> for IpAddr

source§

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

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

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

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

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

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

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

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

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

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

### impl PartialOrd<Ipv6Addr> for IpAddr

source§

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

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

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

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

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

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

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

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

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

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

### impl PartialOrd for IpAddr

source§

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

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

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

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

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

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

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

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

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

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

### impl Copy for IpAddr

source§

### impl Eq for IpAddr

source§

### impl StructuralEq for IpAddr

source§

### impl StructuralPartialEq for IpAddr

## Auto Trait Implementations§

§

### impl RefUnwindSafe for IpAddr

§

### impl Send for IpAddr

§

### impl Sync for IpAddr

§

### impl Unpin for IpAddr

§

### impl UnwindSafe for IpAddr

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

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

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

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

source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

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

#### fn clone_into(&self, target: &mut T)

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

### impl<T> ToString for Twhere T: Display + ?Sized,

source§

#### default fn to_string(&self) -> String

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

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.