W3cubDocs

/Rust

Enum IpAddr

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

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);

Variants

1.7.0
V4(Ipv4Addr)

An IPv4 address.

1.7.0
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);
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);
Source
pub const 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);
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);
Source
pub const 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
);
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);
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);
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);
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 address, otherwise returns 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);
Source
pub const fn as_octets(&self) -> &[u8] ⓘ
🔬This is a nightly-only experimental API. (ip_as_octets #137259)

Returns the eight-bit integers this address consists of as a slice.

Examples
#![feature(ip_as_octets)]

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

assert_eq!(IpAddr::V4(Ipv4Addr::LOCALHOST).as_octets(), &[127, 0, 0, 1]);
assert_eq!(IpAddr::V6(Ipv6Addr::LOCALHOST).as_octets(),
           &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1])
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));

Trait Implementations

1.7.0Source
impl Clone for IpAddr
Source
fn clone(&self) -> IpAddr
Returns a duplicate of the value. Read more
1.0.0Source
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
1.7.0Source
impl Debug for IpAddr
Source
fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
1.7.0Source
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 (const: unstable)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([
    0x20du16, 0x20cu16, 0x20bu16, 0x20au16,
    0x209u16, 0x208u16, 0x207u16, 0x206u16,
]);
assert_eq!(
    IpAddr::V6(Ipv6Addr::new(
        0x20d, 0x20c, 0x20b, 0x20a,
        0x209, 0x208, 0x207, 0x206,
    )),
    addr
);
1.17.0 (const: unstable)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([
    0x19u8, 0x18u8, 0x17u8, 0x16u8, 0x15u8, 0x14u8, 0x13u8, 0x12u8,
    0x11u8, 0x10u8, 0x0fu8, 0x0eu8, 0x0du8, 0x0cu8, 0x0bu8, 0x0au8,
]);
assert_eq!(
    IpAddr::V6(Ipv6Addr::new(
        0x1918, 0x1716, 0x1514, 0x1312,
        0x1110, 0x0f0e, 0x0d0c, 0x0b0a,
    )),
    addr
);
1.17.0 (const: unstable)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);
1.16.0 (const: unstable)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)
)
1.16.0 (const: unstable)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)
);
1.7.0Source
impl FromStr for IpAddr
Source
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
1.7.0Source
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.0Source
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
1.7.0Source
impl Ord for IpAddr
Source
fn cmp(&self, other: &IpAddr) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0Source
fn max(self, other: Self) -> Selfwhere
    Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0Source
fn min(self, other: Self) -> Selfwhere
    Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0Source
fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized,
Restrict a value to a certain interval. Read more
1.16.0Source
impl PartialEq<IpAddr> for Ipv4Addr
Source
fn eq(&self, other: &IpAddr) -> bool
Tests for self and other values to be equal, and is used by ==.
1.0.0Source
fn ne(&self, other: &Rhs) -> bool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0Source
impl PartialEq<IpAddr> for Ipv6Addr
Source
fn eq(&self, other: &IpAddr) -> bool
Tests for self and other values to be equal, and is used by ==.
1.0.0Source
fn ne(&self, other: &Rhs) -> bool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0Source
impl PartialEq<Ipv4Addr> for IpAddr
Source
fn eq(&self, other: &Ipv4Addr) -> bool
Tests for self and other values to be equal, and is used by ==.
1.0.0Source
fn ne(&self, other: &Rhs) -> bool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0Source
impl PartialEq<Ipv6Addr> for IpAddr
Source
fn eq(&self, other: &Ipv6Addr) -> bool
Tests for self and other values to be equal, and is used by ==.
1.0.0Source
fn ne(&self, other: &Rhs) -> bool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.7.0Source
impl PartialEq for IpAddr
Source
fn eq(&self, other: &IpAddr) -> bool
Tests for self and other values to be equal, and is used by ==.
1.0.0Source
fn ne(&self, other: &Rhs) -> bool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.16.0Source
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.0Source
fn lt(&self, other: &Rhs) -> bool
Tests less than (for self and other) and is used by the < operator. Read more
1.0.0Source
fn le(&self, other: &Rhs) -> bool
Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0Source
fn gt(&self, other: &Rhs) -> bool
Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0Source
fn ge(&self, other: &Rhs) -> bool
Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
1.16.0Source
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.0Source
fn lt(&self, other: &Rhs) -> bool
Tests less than (for self and other) and is used by the < operator. Read more
1.0.0Source
fn le(&self, other: &Rhs) -> bool
Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0Source
fn gt(&self, other: &Rhs) -> bool
Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0Source
fn ge(&self, other: &Rhs) -> bool
Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
1.16.0Source
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.0Source
fn lt(&self, other: &Rhs) -> bool
Tests less than (for self and other) and is used by the < operator. Read more
1.0.0Source
fn le(&self, other: &Rhs) -> bool
Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0Source
fn gt(&self, other: &Rhs) -> bool
Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0Source
fn ge(&self, other: &Rhs) -> bool
Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
1.16.0Source
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.0Source
fn lt(&self, other: &Rhs) -> bool
Tests less than (for self and other) and is used by the < operator. Read more
1.0.0Source
fn le(&self, other: &Rhs) -> bool
Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0Source
fn gt(&self, other: &Rhs) -> bool
Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0Source
fn ge(&self, other: &Rhs) -> bool
Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
1.7.0Source
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.0Source
fn lt(&self, other: &Rhs) -> bool
Tests less than (for self and other) and is used by the < operator. Read more
1.0.0Source
fn le(&self, other: &Rhs) -> bool
Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0Source
fn gt(&self, other: &Rhs) -> bool
Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0Source
fn ge(&self, other: &Rhs) -> bool
Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
1.7.0Source
impl Copy for IpAddr
1.7.0Source
impl Eq for IpAddr
1.7.0Source
impl StructuralPartialEq for IpAddr

Auto Trait Implementations

impl Freeze for IpAddr
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> CloneToUninit for Twhere
    T: Clone,
Source
unsafe fn clone_to_uninit(&self, dest: *mut u8)
🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. 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,
Source
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
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>,
Source
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>,
Source
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.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/net/enum.IpAddr.html