pub struct Ipv6Addr { /* private fields */ }
Expand description
An IPv6 address.
IPv6 addresses are defined as 128-bit integers in IETF RFC 4291. They are usually represented as eight 16-bit segments.
The size of an Ipv6Addr
struct may vary depending on the target operating
system.
Embedding IPv4 Addresses
See IpAddr
for a type encompassing both IPv4 and IPv6 addresses.
To assist in the transition from IPv4 to IPv6 two types of IPv6 addresses that embed an IPv4 address were defined: IPv4-compatible and IPv4-mapped addresses. Of these IPv4-compatible addresses have been officially deprecated.
Both types of addresses are not assigned any special meaning by this implementation,
other than what the relevant standards prescribe. This means that an address like ::ffff:127.0.0.1
,
while representing an IPv4 loopback address, is not itself an IPv6 loopback address; only ::1
is.
To handle these so called “IPv4-in-IPv6” addresses, they have to first be converted to their canonical IPv4 address.
IPv4-Compatible IPv6 Addresses
IPv4-compatible IPv6 addresses are defined in IETF RFC 4291 Section 2.5.5.1, and have been officially deprecated. The RFC describes the format of an “IPv4-Compatible IPv6 address” as follows:
| 80 bits | 16 | 32 bits |
+--------------------------------------+--------------------------+
|0000..............................0000|0000| IPv4 address |
+--------------------------------------+----+---------------------+
So ::a.b.c.d
would be an IPv4-compatible IPv6 address representing the IPv4 address a.b.c.d
.
To convert from an IPv4 address to an IPv4-compatible IPv6 address, use Ipv4Addr::to_ipv6_compatible
.
Use Ipv6Addr::to_ipv4
to convert an IPv4-compatible IPv6 address to the canonical IPv4 address.
IPv4-Mapped IPv6 Addresses
IPv4-mapped IPv6 addresses are defined in IETF RFC 4291 Section 2.5.5.2. The RFC describes the format of an “IPv4-Mapped IPv6 address” as follows:
| 80 bits | 16 | 32 bits |
+--------------------------------------+--------------------------+
|0000..............................0000|FFFF| IPv4 address |
+--------------------------------------+----+---------------------+
So ::ffff:a.b.c.d
would be an IPv4-mapped IPv6 address representing the IPv4 address a.b.c.d
.
To convert from an IPv4 address to an IPv4-mapped IPv6 address, use Ipv4Addr::to_ipv6_mapped
.
Use Ipv6Addr::to_ipv4
to convert an IPv4-mapped IPv6 address to the canonical IPv4 address.
Note that this will also convert the IPv6 loopback address ::1
to 0.0.0.1
. Use
Ipv6Addr::to_ipv4_mapped
to avoid this.
Textual representation
Ipv6Addr
provides a FromStr
implementation. There are many ways to represent
an IPv6 address in text, but in general, each segments is written in hexadecimal
notation, and segments are separated by :
. For more information, see
IETF RFC 5952.
Examples
use std::net::Ipv6Addr;
let localhost = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
assert_eq!("::1".parse(), Ok(localhost));
assert_eq!(localhost.is_loopback(), true);
RunImplementations
sourceimpl Ipv6Addr
impl Ipv6Addr
const: 1.32.0 · sourcepub const fn new(
a: u16,
b: u16,
c: u16,
d: u16,
e: u16,
f: u16,
g: u16,
h: u16
) -> Ipv6Addr
pub const fn new(
a: u16,
b: u16,
c: u16,
d: u16,
e: u16,
f: u16,
g: u16,
h: u16
) -> Ipv6Addr
1.30.0 · sourcepub const UNSPECIFIED: Self = _
pub const UNSPECIFIED: Self = _
1.7.0 (const: 1.50.0) · sourcepub const fn is_unspecified(&self) -> bool
pub const fn is_unspecified(&self) -> bool
Returns true
for the special ‘unspecified’ address (::
).
This property is defined in IETF RFC 4291.
Examples
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);
Run1.7.0 (const: 1.50.0) · sourcepub const fn is_loopback(&self) -> bool
pub const fn is_loopback(&self) -> bool
Returns true
if this is the loopback address (::1
),
as defined in IETF RFC 4291 section 2.5.3.
Contrary to IPv4, in IPv6 there is only one loopback address.
Examples
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);
Runconst: unstable · sourcepub fn is_global(&self) -> bool
pub fn is_global(&self) -> bool
Returns true
if the address appears to be globally routable.
The following return false
:
- the loopback address
- link-local and unique local unicast addresses
- interface-, link-, realm-, admin- and site-local multicast addresses
Examples
#![feature(ip)]
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false);
assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true);
Runconst: unstable · sourcepub fn is_unique_local(&self) -> bool
pub fn is_unique_local(&self) -> bool
Returns true
if this is a unique local address (fc00::/7
).
This property is defined in IETF RFC 4193.
Examples
#![feature(ip)]
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false);
assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true);
Runconst: unstable · sourcepub fn is_unicast(&self) -> bool
pub fn is_unicast(&self) -> bool
Returns true
if this is a unicast address, as defined by IETF RFC 4291.
Any address that is not a multicast address (ff00::/8
) is unicast.
Examples
#![feature(ip)]
use std::net::Ipv6Addr;
// The unspecified and loopback addresses are unicast.
assert_eq!(Ipv6Addr::UNSPECIFIED.is_unicast(), true);
assert_eq!(Ipv6Addr::LOCALHOST.is_unicast(), true);
// Any address that is not a multicast address (`ff00::/8`) is unicast.
assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast(), true);
assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_unicast(), false);
Runconst: unstable · sourcepub fn is_unicast_link_local(&self) -> bool
pub fn is_unicast_link_local(&self) -> bool
Returns true
if the address is a unicast address with link-local scope,
as defined in RFC 4291.
A unicast address has link-local scope if it has the prefix fe80::/10
, as per RFC 4291 section 2.4.
Note that this encompasses more addresses than those defined in RFC 4291 section 2.5.6,
which describes “Link-Local IPv6 Unicast Addresses” as having the following stricter format:
| 10 bits | 54 bits | 64 bits |
+----------+-------------------------+----------------------------+
|1111111010| 0 | interface ID |
+----------+-------------------------+----------------------------+
So while currently the only addresses with link-local scope an application will encounter are all in fe80::/64
,
this might change in the future with the publication of new standards. More addresses in fe80::/10
could be allocated,
and those addresses will have link-local scope.
Also note that while RFC 4291 section 2.5.3 mentions about the loopback address (::1
) that “it is treated as having Link-Local scope”,
this does not mean that the loopback address actually has link-local scope and this method will return false
on it.
Examples
#![feature(ip)]
use std::net::Ipv6Addr;
// The loopback address (`::1`) does not actually have link-local scope.
assert_eq!(Ipv6Addr::LOCALHOST.is_unicast_link_local(), false);
// Only addresses in `fe80::/10` have link-local scope.
assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), false);
assert_eq!(Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), true);
// Addresses outside the stricter `fe80::/64` also have link-local scope.
assert_eq!(Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0).is_unicast_link_local(), true);
assert_eq!(Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), true);
Runconst: unstable · sourcepub fn is_documentation(&self) -> bool
pub fn is_documentation(&self) -> bool
Returns true
if this is an address reserved for documentation
(2001:db8::/32
).
This property is defined in IETF RFC 3849.
Examples
#![feature(ip)]
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false);
assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true);
Runsourcepub const fn is_benchmarking(&self) -> bool
pub const fn is_benchmarking(&self) -> bool
Returns true
if this is an address reserved for benchmarking (2001:2::/48
).
This property is defined in IETF RFC 5180, where it is mistakenly specified as covering the range 2001:0200::/48
.
This is corrected in IETF RFC Errata 1752 to 2001:0002::/48
.
#![feature(ip)]
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc613, 0x0).is_benchmarking(), false);
assert_eq!(Ipv6Addr::new(0x2001, 0x2, 0, 0, 0, 0, 0, 0).is_benchmarking(), true);
Runconst: unstable · sourcepub fn is_unicast_global(&self) -> bool
pub fn is_unicast_global(&self) -> bool
Returns true
if the address is a globally routable unicast address.
The following return false:
- the loopback address
- the link-local addresses
- unique local addresses
- the unspecified address
- the address range reserved for documentation
This method returns true
for site-local addresses as per RFC 4291 section 2.5.7
The special behavior of [the site-local unicast] prefix defined in [RFC3513] must no longer
be supported in new implementations (i.e., new implementations must treat this prefix as
Global Unicast).
Examples
#![feature(ip)]
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true);
Runconst: unstable · sourcepub fn multicast_scope(&self) -> Option<Ipv6MulticastScope>
pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope>
Returns the address’s multicast scope if the address is multicast.
Examples
#![feature(ip)]
use std::net::{Ipv6Addr, Ipv6MulticastScope};
assert_eq!(
Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(),
Some(Ipv6MulticastScope::Global)
);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None);
Run1.7.0 (const: 1.50.0) · sourcepub const fn is_multicast(&self) -> bool
pub const fn is_multicast(&self) -> bool
Returns true
if this is a multicast address (ff00::/8
).
This property is defined by IETF RFC 4291.
Examples
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);
Run1.63.0 (const: unstable) · sourcepub fn to_ipv4_mapped(&self) -> Option<Ipv4Addr>
pub fn to_ipv4_mapped(&self) -> Option<Ipv4Addr>
Converts this address to an IPv4
address if it’s an IPv4-mapped address,
as defined in IETF RFC 4291 section 2.5.5.2, otherwise returns None
.
::ffff:a.b.c.d
becomes a.b.c.d
.
All addresses not starting with ::ffff
will return None
.
Examples
use std::net::{Ipv4Addr, Ipv6Addr};
assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4_mapped(), None);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4_mapped(),
Some(Ipv4Addr::new(192, 10, 2, 255)));
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4_mapped(), None);
Runconst: 1.50.0 · sourcepub const fn to_ipv4(&self) -> Option<Ipv4Addr>
pub const fn to_ipv4(&self) -> Option<Ipv4Addr>
Converts this address to an IPv4
address if it is either
an IPv4-compatible address as defined in IETF RFC 4291 section 2.5.5.1,
or an IPv4-mapped address as defined in IETF RFC 4291 section 2.5.5.2,
otherwise returns None
.
Note that this will return an IPv4
address for the IPv6 loopback address ::1
. Use
Ipv6Addr::to_ipv4_mapped
to avoid this.
::a.b.c.d
and ::ffff:a.b.c.d
become a.b.c.d
. ::1
becomes 0.0.0.1
.
All addresses not starting with either all zeroes or ::ffff
will return None
.
Examples
use std::net::{Ipv4Addr, Ipv6Addr};
assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(),
Some(Ipv4Addr::new(192, 10, 2, 255)));
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(),
Some(Ipv4Addr::new(0, 0, 0, 1)));
Runconst: unstable · sourcepub fn to_canonical(&self) -> IpAddr
pub fn to_canonical(&self) -> IpAddr
Converts this address to an IpAddr::V4
if it is an IPv4-mapped addresses, otherwise it
returns self wrapped in an IpAddr::V6
.
Examples
#![feature(ip)]
use std::net::Ipv6Addr;
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x7f00, 0x1).is_loopback(), false);
assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x7f00, 0x1).to_canonical().is_loopback(), true);
RunTrait Implementations
sourceimpl Display for Ipv6Addr
impl Display for Ipv6Addr
Write an Ipv6Addr, conforming to the canonical style described by RFC 5952.
1.9.0 · sourceimpl From<[u8; 16]> for Ipv6Addr
impl From<[u8; 16]> for Ipv6Addr
sourcefn from(octets: [u8; 16]) -> Ipv6Addr
fn from(octets: [u8; 16]) -> Ipv6Addr
Creates an Ipv6Addr
from a sixteen element byte array.
Examples
use std::net::Ipv6Addr;
let addr = Ipv6Addr::from([
25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
]);
assert_eq!(
Ipv6Addr::new(
0x1918, 0x1716,
0x1514, 0x1312,
0x1110, 0x0f0e,
0x0d0c, 0x0b0a
),
addr
);
Runsourceimpl FromStr for Ipv6Addr
impl FromStr for Ipv6Addr
type Err = AddrParseError
type Err = AddrParseError
The associated error which can be returned from parsing.
sourceimpl Ord for Ipv6Addr
impl Ord for Ipv6Addr
1.16.0 · sourceimpl PartialOrd<IpAddr> for Ipv6Addr
impl PartialOrd<IpAddr> for Ipv6Addr
sourcefn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>
fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
sourcefn le(&self, other: &Rhs) -> bool
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.16.0 · sourceimpl PartialOrd<Ipv6Addr> for IpAddr
impl PartialOrd<Ipv6Addr> for IpAddr
sourcefn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>
fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
sourcefn le(&self, other: &Rhs) -> bool
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
sourceimpl PartialOrd<Ipv6Addr> for Ipv6Addr
impl PartialOrd<Ipv6Addr> for Ipv6Addr
sourcefn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>
fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
sourcefn le(&self, other: &Rhs) -> bool
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
impl Copy for Ipv6Addr
impl Eq for Ipv6Addr
Auto Trait Implementations
impl RefUnwindSafe for Ipv6Addr
impl Send for Ipv6Addr
impl Sync for Ipv6Addr
impl Unpin for Ipv6Addr
impl UnwindSafe for Ipv6Addr
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more