src/libstd/net/ip.rs

   1 #![unstable(
   2     feature = "ip",
   3     reason = "extra functionality has not been \
   4                                       scrutinized to the level that it should \
   5                                       be to be stable",
   6     issue = "27709"
   7 )]
   8
   9 use crate::cmp::Ordering;
  10 use crate::fmt;
  11 use crate::hash;
  12 use crate::io::Write;
  13 use crate::sys::net::netc as c;
  14 use crate::sys_common::{AsInner, FromInner};
  15
  16 /// An IP address, either IPv4 or IPv6.
  17 ///
  18 /// This enum can contain either an [`Ipv4Addr`] or an [`Ipv6Addr`], see their
  19 /// respective documentation for more details.
  20 ///
  21 /// The size of an `IpAddr` instance may vary depending on the target operating
  22 /// system.
  23 ///
  24 /// [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
  25 /// [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
  26 ///
  27 /// # Examples
  28 ///
  29 /// ```
  30 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
  31 ///
  32 /// let localhost_v4 = IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1));
  33 /// let localhost_v6 = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
  34 ///
  35 /// assert_eq!("127.0.0.1".parse(), Ok(localhost_v4));
  36 /// assert_eq!("::1".parse(), Ok(localhost_v6));
  37 ///
  38 /// assert_eq!(localhost_v4.is_ipv6(), false);
  39 /// assert_eq!(localhost_v4.is_ipv4(), true);
  40 /// ```
  41 #[stable(feature = "ip_addr", since = "1.7.0")]
  42 #[derive(Copy, Clone, Eq, PartialEq, Debug, Hash, PartialOrd, Ord)]
  43 pub enum IpAddr {
  44     /// An IPv4 address.
  45     #[stable(feature = "ip_addr", since = "1.7.0")]
  46     V4(#[stable(feature = "ip_addr", since = "1.7.0")] Ipv4Addr),
  47     /// An IPv6 address.
  48     #[stable(feature = "ip_addr", since = "1.7.0")]
  49     V6(#[stable(feature = "ip_addr", since = "1.7.0")] Ipv6Addr),
  50 }
  51
  52 /// An IPv4 address.
  53 ///
  54 /// IPv4 addresses are defined as 32-bit integers in [IETF RFC 791].
  55 /// They are usually represented as four octets.
  56 ///
  57 /// See [`IpAddr`] for a type encompassing both IPv4 and IPv6 addresses.
  58 ///
  59 /// The size of an `Ipv4Addr` struct may vary depending on the target operating
  60 /// system.
  61 ///
  62 /// [IETF RFC 791]: https://tools.ietf.org/html/rfc791
  63 /// [`IpAddr`]: ../../std/net/enum.IpAddr.html
  64 ///
  65 /// # Textual representation
  66 ///
  67 /// `Ipv4Addr` provides a [`FromStr`] implementation. The four octets are in decimal
  68 /// notation, divided by `.` (this is called "dot-decimal notation").
  69 ///
  70 /// [`FromStr`]: ../../std/str/trait.FromStr.html
  71 ///
  72 /// # Examples
  73 ///
  74 /// ```
  75 /// use std::net::Ipv4Addr;
  76 ///
  77 /// let localhost = Ipv4Addr::new(127, 0, 0, 1);
  78 /// assert_eq!("127.0.0.1".parse(), Ok(localhost));
  79 /// assert_eq!(localhost.is_loopback(), true);
  80 /// ```
  81 #[derive(Copy)]
  82 #[stable(feature = "rust1", since = "1.0.0")]
  83 pub struct Ipv4Addr {
  84     inner: c::in_addr,
  85 }
  86
  87 /// An IPv6 address.
  88 ///
  89 /// IPv6 addresses are defined as 128-bit integers in [IETF RFC 4291].
  90 /// They are usually represented as eight 16-bit segments.
  91 ///
  92 /// See [`IpAddr`] for a type encompassing both IPv4 and IPv6 addresses.
  93 ///
  94 /// The size of an `Ipv6Addr` struct may vary depending on the target operating
  95 /// system.
  96 ///
  97 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
  98 /// [`IpAddr`]: ../../std/net/enum.IpAddr.html
  99 ///
 100 /// # Textual representation
 101 ///
 102 /// `Ipv6Addr` provides a [`FromStr`] implementation. There are many ways to represent
 103 /// an IPv6 address in text, but in general, each segments is written in hexadecimal
 104 /// notation, and segments are separated by `:`. For more information, see
 105 /// [IETF RFC 5952].
 106 ///
 107 /// [`FromStr`]: ../../std/str/trait.FromStr.html
 108 /// [IETF RFC 5952]: https://tools.ietf.org/html/rfc5952
 109 ///
 110 /// # Examples
 111 ///
 112 /// ```
 113 /// use std::net::Ipv6Addr;
 114 ///
 115 /// let localhost = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
 116 /// assert_eq!("::1".parse(), Ok(localhost));
 117 /// assert_eq!(localhost.is_loopback(), true);
 118 /// ```
 119 #[derive(Copy)]
 120 #[stable(feature = "rust1", since = "1.0.0")]
 121 pub struct Ipv6Addr {
 122     inner: c::in6_addr,
 123 }
 124
 125 #[allow(missing_docs)]
 126 #[derive(Copy, PartialEq, Eq, Clone, Hash, Debug)]
 127 pub enum Ipv6MulticastScope {
 128     InterfaceLocal,
 129     LinkLocal,
 130     RealmLocal,
 131     AdminLocal,
 132     SiteLocal,
 133     OrganizationLocal,
 134     Global,
 135 }
 136
 137 impl IpAddr {
 138     /// Returns [`true`] for the special 'unspecified' address.
 139     ///
 140     /// See the documentation for [`Ipv4Addr::is_unspecified`][IPv4] and
 141     /// [`Ipv6Addr::is_unspecified`][IPv6] for more details.
 142     ///
 143     /// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_unspecified
 144     /// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_unspecified
 145     /// [`true`]: ../../std/primitive.bool.html
 146     ///
 147     /// # Examples
 148     ///
 149     /// ```
 150     /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 151     ///
 152     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)).is_unspecified(), true);
 153     /// assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)).is_unspecified(), true);
 154     /// ```
 155     #[stable(feature = "ip_shared", since = "1.12.0")]
 156     pub fn is_unspecified(&self) -> bool {
 157         match self {
 158             IpAddr::V4(ip) => ip.is_unspecified(),
 159             IpAddr::V6(ip) => ip.is_unspecified(),
 160         }
 161     }
 162
 163     /// Returns [`true`] if this is a loopback address.
 164     ///
 165     /// See the documentation for [`Ipv4Addr::is_loopback`][IPv4] and
 166     /// [`Ipv6Addr::is_loopback`][IPv6] for more details.
 167     ///
 168     /// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_loopback
 169     /// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_loopback
 170     /// [`true`]: ../../std/primitive.bool.html
 171     ///
 172     /// # Examples
 173     ///
 174     /// ```
 175     /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 176     ///
 177     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)).is_loopback(), true);
 178     /// assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1)).is_loopback(), true);
 179     /// ```
 180     #[stable(feature = "ip_shared", since = "1.12.0")]
 181     pub fn is_loopback(&self) -> bool {
 182         match self {
 183             IpAddr::V4(ip) => ip.is_loopback(),
 184             IpAddr::V6(ip) => ip.is_loopback(),
 185         }
 186     }
 187
 188     /// Returns [`true`] if the address appears to be globally routable.
 189     ///
 190     /// See the documentation for [`Ipv4Addr::is_global`][IPv4] and
 191     /// [`Ipv6Addr::is_global`][IPv6] for more details.
 192     ///
 193     /// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_global
 194     /// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_global
 195     /// [`true`]: ../../std/primitive.bool.html
 196     ///
 197     /// # Examples
 198     ///
 199     /// ```
 200     /// #![feature(ip)]
 201     ///
 202     /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 203     ///
 204     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(80, 9, 12, 3)).is_global(), true);
 205     /// assert_eq!(IpAddr::V6(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1)).is_global(), true);
 206     /// ```
 207     pub fn is_global(&self) -> bool {
 208         match self {
 209             IpAddr::V4(ip) => ip.is_global(),
 210             IpAddr::V6(ip) => ip.is_global(),
 211         }
 212     }
 213
 214     /// Returns [`true`] if this is a multicast address.
 215     ///
 216     /// See the documentation for [`Ipv4Addr::is_multicast`][IPv4] and
 217     /// [`Ipv6Addr::is_multicast`][IPv6] for more details.
 218     ///
 219     /// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_multicast
 220     /// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_multicast
 221     /// [`true`]: ../../std/primitive.bool.html
 222     ///
 223     /// # Examples
 224     ///
 225     /// ```
 226     /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 227     ///
 228     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(224, 254, 0, 0)).is_multicast(), true);
 229     /// assert_eq!(IpAddr::V6(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0)).is_multicast(), true);
 230     /// ```
 231     #[stable(feature = "ip_shared", since = "1.12.0")]
 232     pub fn is_multicast(&self) -> bool {
 233         match self {
 234             IpAddr::V4(ip) => ip.is_multicast(),
 235             IpAddr::V6(ip) => ip.is_multicast(),
 236         }
 237     }
 238
 239     /// Returns [`true`] if this address is in a range designated for documentation.
 240     ///
 241     /// See the documentation for [`Ipv4Addr::is_documentation`][IPv4] and
 242     /// [`Ipv6Addr::is_documentation`][IPv6] for more details.
 243     ///
 244     /// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_documentation
 245     /// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_documentation
 246     /// [`true`]: ../../std/primitive.bool.html
 247     ///
 248     /// # Examples
 249     ///
 250     /// ```
 251     /// #![feature(ip)]
 252     ///
 253     /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 254     ///
 255     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_documentation(), true);
 256     /// assert_eq!(
 257     ///     IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_documentation(),
 258     ///     true
 259     /// );
 260     /// ```
 261     pub fn is_documentation(&self) -> bool {
 262         match self {
 263             IpAddr::V4(ip) => ip.is_documentation(),
 264             IpAddr::V6(ip) => ip.is_documentation(),
 265         }
 266     }
 267
 268     /// Returns [`true`] if this address is an [IPv4 address], and [`false`] otherwise.
 269     ///
 270     /// [`true`]: ../../std/primitive.bool.html
 271     /// [`false`]: ../../std/primitive.bool.html
 272     /// [IPv4 address]: #variant.V4
 273     ///
 274     /// # Examples
 275     ///
 276     /// ```
 277     /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 278     ///
 279     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_ipv4(), true);
 280     /// assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_ipv4(), false);
 281     /// ```
 282     #[stable(feature = "ipaddr_checker", since = "1.16.0")]
 283     pub fn is_ipv4(&self) -> bool {
 284         matches!(self, IpAddr::V4(_))
 285     }
 286
 287     /// Returns [`true`] if this address is an [IPv6 address], and [`false`] otherwise.
 288     ///
 289     /// [`true`]: ../../std/primitive.bool.html
 290     /// [`false`]: ../../std/primitive.bool.html
 291     /// [IPv6 address]: #variant.V6
 292     ///
 293     /// # Examples
 294     ///
 295     /// ```
 296     /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 297     ///
 298     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_ipv6(), false);
 299     /// assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_ipv6(), true);
 300     /// ```
 301     #[stable(feature = "ipaddr_checker", since = "1.16.0")]
 302     pub fn is_ipv6(&self) -> bool {
 303         matches!(self, IpAddr::V6(_))
 304     }
 305 }
 306
 307 impl Ipv4Addr {
 308     /// Creates a new IPv4 address from four eight-bit octets.
 309     ///
 310     /// The result will represent the IP address `a`.`b`.`c`.`d`.
 311     ///
 312     /// # Examples
 313     ///
 314     /// ```
 315     /// use std::net::Ipv4Addr;
 316     ///
 317     /// let addr = Ipv4Addr::new(127, 0, 0, 1);
 318     /// ```
 319     #[stable(feature = "rust1", since = "1.0.0")]
 320     #[rustc_const_stable(feature = "const_ipv4", since = "1.32.0")]
 321     pub const fn new(a: u8, b: u8, c: u8, d: u8) -> Ipv4Addr {
 322         // FIXME: should just be u32::from_be_bytes([a, b, c, d]),
 323         // once that method is no longer rustc_const_unstable
 324         Ipv4Addr {
 325             inner: c::in_addr {
 326                 s_addr: u32::to_be(
 327                     ((a as u32) << 24) | ((b as u32) << 16) | ((c as u32) << 8) | (d as u32),
 328                 ),
 329             },
 330         }
 331     }
 332
 333     /// An IPv4 address with the address pointing to localhost: 127.0.0.1.
 334     ///
 335     /// # Examples
 336     ///
 337     /// ```
 338     /// use std::net::Ipv4Addr;
 339     ///
 340     /// let addr = Ipv4Addr::LOCALHOST;
 341     /// assert_eq!(addr, Ipv4Addr::new(127, 0, 0, 1));
 342     /// ```
 343     #[stable(feature = "ip_constructors", since = "1.30.0")]
 344     pub const LOCALHOST: Self = Ipv4Addr::new(127, 0, 0, 1);
 345
 346     /// An IPv4 address representing an unspecified address: 0.0.0.0
 347     ///
 348     /// # Examples
 349     ///
 350     /// ```
 351     /// use std::net::Ipv4Addr;
 352     ///
 353     /// let addr = Ipv4Addr::UNSPECIFIED;
 354     /// assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));
 355     /// ```
 356     #[stable(feature = "ip_constructors", since = "1.30.0")]
 357     pub const UNSPECIFIED: Self = Ipv4Addr::new(0, 0, 0, 0);
 358
 359     /// An IPv4 address representing the broadcast address: 255.255.255.255
 360     ///
 361     /// # Examples
 362     ///
 363     /// ```
 364     /// use std::net::Ipv4Addr;
 365     ///
 366     /// let addr = Ipv4Addr::BROADCAST;
 367     /// assert_eq!(addr, Ipv4Addr::new(255, 255, 255, 255));
 368     /// ```
 369     #[stable(feature = "ip_constructors", since = "1.30.0")]
 370     pub const BROADCAST: Self = Ipv4Addr::new(255, 255, 255, 255);
 371
 372     /// Returns the four eight-bit integers that make up this address.
 373     ///
 374     /// # Examples
 375     ///
 376     /// ```
 377     /// use std::net::Ipv4Addr;
 378     ///
 379     /// let addr = Ipv4Addr::new(127, 0, 0, 1);
 380     /// assert_eq!(addr.octets(), [127, 0, 0, 1]);
 381     /// ```
 382     #[stable(feature = "rust1", since = "1.0.0")]
 383     pub fn octets(&self) -> [u8; 4] {
 384         // This returns the order we want because s_addr is stored in big-endian.
 385         self.inner.s_addr.to_ne_bytes()
 386     }
 387
 388     /// Returns [`true`] for the special 'unspecified' address (0.0.0.0).
 389     ///
 390     /// This property is defined in _UNIX Network Programming, Second Edition_,
 391     /// W. Richard Stevens, p. 891; see also [ip7].
 392     ///
 393     /// [ip7]: http://man7.org/linux/man-pages/man7/ip.7.html
 394     /// [`true`]: ../../std/primitive.bool.html
 395     ///
 396     /// # Examples
 397     ///
 398     /// ```
 399     /// use std::net::Ipv4Addr;
 400     ///
 401     /// assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_unspecified(), true);
 402     /// assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_unspecified(), false);
 403     /// ```
 404     #[stable(feature = "ip_shared", since = "1.12.0")]
 405     #[rustc_const_stable(feature = "const_ipv4", since = "1.32.0")]
 406     pub const fn is_unspecified(&self) -> bool {
 407         self.inner.s_addr == 0
 408     }
 409
 410     /// Returns [`true`] if this is a loopback address (127.0.0.0/8).
 411     ///
 412     /// This property is defined by [IETF RFC 1122].
 413     ///
 414     /// [IETF RFC 1122]: https://tools.ietf.org/html/rfc1122
 415     /// [`true`]: ../../std/primitive.bool.html
 416     ///
 417     /// # Examples
 418     ///
 419     /// ```
 420     /// use std::net::Ipv4Addr;
 421     ///
 422     /// assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_loopback(), true);
 423     /// assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_loopback(), false);
 424     /// ```
 425     #[stable(since = "1.7.0", feature = "ip_17")]
 426     pub fn is_loopback(&self) -> bool {
 427         self.octets()[0] == 127
 428     }
 429
 430     /// Returns [`true`] if this is a private address.
 431     ///
 432     /// The private address ranges are defined in [IETF RFC 1918] and include:
 433     ///
 434     ///  - 10.0.0.0/8
 435     ///  - 172.16.0.0/12
 436     ///  - 192.168.0.0/16
 437     ///
 438     /// [IETF RFC 1918]: https://tools.ietf.org/html/rfc1918
 439     /// [`true`]: ../../std/primitive.bool.html
 440     ///
 441     /// # Examples
 442     ///
 443     /// ```
 444     /// use std::net::Ipv4Addr;
 445     ///
 446     /// assert_eq!(Ipv4Addr::new(10, 0, 0, 1).is_private(), true);
 447     /// assert_eq!(Ipv4Addr::new(10, 10, 10, 10).is_private(), true);
 448     /// assert_eq!(Ipv4Addr::new(172, 16, 10, 10).is_private(), true);
 449     /// assert_eq!(Ipv4Addr::new(172, 29, 45, 14).is_private(), true);
 450     /// assert_eq!(Ipv4Addr::new(172, 32, 0, 2).is_private(), false);
 451     /// assert_eq!(Ipv4Addr::new(192, 168, 0, 2).is_private(), true);
 452     /// assert_eq!(Ipv4Addr::new(192, 169, 0, 2).is_private(), false);
 453     /// ```
 454     #[stable(since = "1.7.0", feature = "ip_17")]
 455     pub fn is_private(&self) -> bool {
 456         match self.octets() {
 457             [10, ..] => true,
 458             [172, b, ..] if b >= 16 && b <= 31 => true,
 459             [192, 168, ..] => true,
 460             _ => false,
 461         }
 462     }
 463
 464     /// Returns [`true`] if the address is link-local (169.254.0.0/16).
 465     ///
 466     /// This property is defined by [IETF RFC 3927].
 467     ///
 468     /// [IETF RFC 3927]: https://tools.ietf.org/html/rfc3927
 469     /// [`true`]: ../../std/primitive.bool.html
 470     ///
 471     /// # Examples
 472     ///
 473     /// ```
 474     /// use std::net::Ipv4Addr;
 475     ///
 476     /// assert_eq!(Ipv4Addr::new(169, 254, 0, 0).is_link_local(), true);
 477     /// assert_eq!(Ipv4Addr::new(169, 254, 10, 65).is_link_local(), true);
 478     /// assert_eq!(Ipv4Addr::new(16, 89, 10, 65).is_link_local(), false);
 479     /// ```
 480     #[stable(since = "1.7.0", feature = "ip_17")]
 481     pub fn is_link_local(&self) -> bool {
 482         match self.octets() {
 483             [169, 254, ..] => true,
 484             _ => false,
 485         }
 486     }
 487
 488     /// Returns [`true`] if the address appears to be globally routable.
 489     /// See [iana-ipv4-special-registry][ipv4-sr].
 490     ///
 491     /// The following return false:
 492     ///
 493     /// - private addresses (see [`is_private()`](#method.is_private))
 494     /// - the loopback address (see [`is_loopback()`](#method.is_loopback))
 495     /// - the link-local address (see [`is_link_local()`](#method.is_link_local))
 496     /// - the broadcast address (see [`is_broadcast()`](#method.is_broadcast))
 497     /// - addresses used for documentation (see [`is_documentation()`](#method.is_documentation))
 498     /// - the unspecified address (see [`is_unspecified()`](#method.is_unspecified)), and the whole
 499     ///   0.0.0.0/8 block
 500     /// - addresses reserved for future protocols (see
 501     /// [`is_ietf_protocol_assignment()`](#method.is_ietf_protocol_assignment), except
 502     /// `192.0.0.9/32` and `192.0.0.10/32` which are globally routable
 503     /// - addresses reserved for future use (see [`is_reserved()`](#method.is_reserved)
 504     /// - addresses reserved for networking devices benchmarking (see
 505     /// [`is_benchmarking`](#method.is_benchmarking))
 506     ///
 507     /// [ipv4-sr]: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
 508     /// [`true`]: ../../std/primitive.bool.html
 509     ///
 510     /// # Examples
 511     ///
 512     /// ```
 513     /// #![feature(ip)]
 514     ///
 515     /// use std::net::Ipv4Addr;
 516     ///
 517     /// // private addresses are not global
 518     /// assert_eq!(Ipv4Addr::new(10, 254, 0, 0).is_global(), false);
 519     /// assert_eq!(Ipv4Addr::new(192, 168, 10, 65).is_global(), false);
 520     /// assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_global(), false);
 521     ///
 522     /// // the 0.0.0.0/8 block is not global
 523     /// assert_eq!(Ipv4Addr::new(0, 1, 2, 3).is_global(), false);
 524     /// // in particular, the unspecified address is not global
 525     /// assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_global(), false);
 526     ///
 527     /// // the loopback address is not global
 528     /// assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_global(), false);
 529     ///
 530     /// // link local addresses are not global
 531     /// assert_eq!(Ipv4Addr::new(169, 254, 45, 1).is_global(), false);
 532     ///
 533     /// // the broadcast address is not global
 534     /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_global(), false);
 535     ///
 536     /// // the address space designated for documentation is not global
 537     /// assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_global(), false);
 538     /// assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_global(), false);
 539     /// assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_global(), false);
 540     ///
 541     /// // shared addresses are not global
 542     /// assert_eq!(Ipv4Addr::new(100, 100, 0, 0).is_global(), false);
 543     ///
 544     /// // addresses reserved for protocol assignment are not global
 545     /// assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_global(), false);
 546     /// assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_global(), false);
 547     ///
 548     /// // addresses reserved for future use are not global
 549     /// assert_eq!(Ipv4Addr::new(250, 10, 20, 30).is_global(), false);
 550     ///
 551     /// // addresses reserved for network devices benchmarking are not global
 552     /// assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_global(), false);
 553     ///
 554     /// // All the other addresses are global
 555     /// assert_eq!(Ipv4Addr::new(1, 1, 1, 1).is_global(), true);
 556     /// assert_eq!(Ipv4Addr::new(80, 9, 12, 3).is_global(), true);
 557     /// ```
 558     pub fn is_global(&self) -> bool {
 559         // check if this address is 192.0.0.9 or 192.0.0.10. These addresses are the only two
 560         // globally routable addresses in the 192.0.0.0/24 range.
 561         if u32::from(*self) == 0xc0000009 || u32::from(*self) == 0xc000000a {
 562             return true;
 563         }
 564         !self.is_private()
 565             && !self.is_loopback()
 566             && !self.is_link_local()
 567             && !self.is_broadcast()
 568             && !self.is_documentation()
 569             && !self.is_shared()
 570             && !self.is_ietf_protocol_assignment()
 571             && !self.is_reserved()
 572             && !self.is_benchmarking()
 573             // Make sure the address is not in 0.0.0.0/8
 574             && self.octets()[0] != 0
 575     }
 576
 577     /// Returns [`true`] if this address is part of the Shared Address Space defined in
 578     /// [IETF RFC 6598] (`100.64.0.0/10`).
 579     ///
 580     /// [IETF RFC 6598]: https://tools.ietf.org/html/rfc6598
 581     /// [`true`]: ../../std/primitive.bool.html
 582     ///
 583     /// # Examples
 584     ///
 585     /// ```
 586     /// #![feature(ip)]
 587     /// use std::net::Ipv4Addr;
 588     ///
 589     /// assert_eq!(Ipv4Addr::new(100, 64, 0, 0).is_shared(), true);
 590     /// assert_eq!(Ipv4Addr::new(100, 127, 255, 255).is_shared(), true);
 591     /// assert_eq!(Ipv4Addr::new(100, 128, 0, 0).is_shared(), false);
 592     /// ```
 593     pub fn is_shared(&self) -> bool {
 594         self.octets()[0] == 100 && (self.octets()[1] & 0b1100_0000 == 0b0100_0000)
 595     }
 596
 597     /// Returns [`true`] if this address is part of `192.0.0.0/24`, which is reserved to
 598     /// IANA for IETF protocol assignments, as documented in [IETF RFC 6890].
 599     ///
 600     /// Note that parts of this block are in use:
 601     ///
 602     /// - `192.0.0.8/32` is the "IPv4 dummy address" (see [IETF RFC 7600])
 603     /// - `192.0.0.9/32` is the "Port Control Protocol Anycast" (see [IETF RFC 7723])
 604     /// - `192.0.0.10/32` is used for NAT traversal (see [IETF RFC 8155])
 605     ///
 606     /// [IETF RFC 6890]: https://tools.ietf.org/html/rfc6890
 607     /// [IETF RFC 7600]: https://tools.ietf.org/html/rfc7600
 608     /// [IETF RFC 7723]: https://tools.ietf.org/html/rfc7723
 609     /// [IETF RFC 8155]: https://tools.ietf.org/html/rfc8155
 610     /// [`true`]: ../../std/primitive.bool.html
 611     ///
 612     /// # Examples
 613     ///
 614     /// ```
 615     /// #![feature(ip)]
 616     /// use std::net::Ipv4Addr;
 617     ///
 618     /// assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_ietf_protocol_assignment(), true);
 619     /// assert_eq!(Ipv4Addr::new(192, 0, 0, 8).is_ietf_protocol_assignment(), true);
 620     /// assert_eq!(Ipv4Addr::new(192, 0, 0, 9).is_ietf_protocol_assignment(), true);
 621     /// assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_ietf_protocol_assignment(), true);
 622     /// assert_eq!(Ipv4Addr::new(192, 0, 1, 0).is_ietf_protocol_assignment(), false);
 623     /// assert_eq!(Ipv4Addr::new(191, 255, 255, 255).is_ietf_protocol_assignment(), false);
 624     /// ```
 625     pub fn is_ietf_protocol_assignment(&self) -> bool {
 626         self.octets()[0] == 192 && self.octets()[1] == 0 && self.octets()[2] == 0
 627     }
 628
 629     /// Returns [`true`] if this address part of the `198.18.0.0/15` range, which is reserved for
 630     /// network devices benchmarking. This range is defined in [IETF RFC 2544] as `192.18.0.0`
 631     /// through `198.19.255.255` but [errata 423] corrects it to `198.18.0.0/15`.
 632     ///
 633     /// [IETF RFC 2544]: https://tools.ietf.org/html/rfc2544
 634     /// [errata 423]: https://www.rfc-editor.org/errata/eid423
 635     /// [`true`]: ../../std/primitive.bool.html
 636     ///
 637     /// # Examples
 638     ///
 639     /// ```
 640     /// #![feature(ip)]
 641     /// use std::net::Ipv4Addr;
 642     ///
 643     /// assert_eq!(Ipv4Addr::new(198, 17, 255, 255).is_benchmarking(), false);
 644     /// assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_benchmarking(), true);
 645     /// assert_eq!(Ipv4Addr::new(198, 19, 255, 255).is_benchmarking(), true);
 646     /// assert_eq!(Ipv4Addr::new(198, 20, 0, 0).is_benchmarking(), false);
 647     /// ```
 648     pub fn is_benchmarking(&self) -> bool {
 649         self.octets()[0] == 198 && (self.octets()[1] & 0xfe) == 18
 650     }
 651
 652     /// Returns [`true`] if this address is reserved by IANA for future use. [IETF RFC 1112]
 653     /// defines the block of reserved addresses as `240.0.0.0/4`. This range normally includes the
 654     /// broadcast address `255.255.255.255`, but this implementation explicitely excludes it, since
 655     /// it is obviously not reserved for future use.
 656     ///
 657     /// [IETF RFC 1112]: https://tools.ietf.org/html/rfc1112
 658     /// [`true`]: ../../std/primitive.bool.html
 659     ///
 660     /// # Warning
 661     ///
 662     /// As IANA assigns new addresses, this method will be
 663     /// updated. This may result in non-reserved addresses being
 664     /// treated as reserved in code that relies on an outdated version
 665     /// of this method.
 666     ///
 667     /// # Examples
 668     ///
 669     /// ```
 670     /// #![feature(ip)]
 671     /// use std::net::Ipv4Addr;
 672     ///
 673     /// assert_eq!(Ipv4Addr::new(240, 0, 0, 0).is_reserved(), true);
 674     /// assert_eq!(Ipv4Addr::new(255, 255, 255, 254).is_reserved(), true);
 675     ///
 676     /// assert_eq!(Ipv4Addr::new(239, 255, 255, 255).is_reserved(), false);
 677     /// // The broadcast address is not considered as reserved for future use by this implementation
 678     /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_reserved(), false);
 679     /// ```
 680     pub fn is_reserved(&self) -> bool {
 681         self.octets()[0] & 240 == 240 && !self.is_broadcast()
 682     }
 683
 684     /// Returns [`true`] if this is a multicast address (224.0.0.0/4).
 685     ///
 686     /// Multicast addresses have a most significant octet between 224 and 239,
 687     /// and is defined by [IETF RFC 5771].
 688     ///
 689     /// [IETF RFC 5771]: https://tools.ietf.org/html/rfc5771
 690     /// [`true`]: ../../std/primitive.bool.html
 691     ///
 692     /// # Examples
 693     ///
 694     /// ```
 695     /// use std::net::Ipv4Addr;
 696     ///
 697     /// assert_eq!(Ipv4Addr::new(224, 254, 0, 0).is_multicast(), true);
 698     /// assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_multicast(), true);
 699     /// assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_multicast(), false);
 700     /// ```
 701     #[stable(since = "1.7.0", feature = "ip_17")]
 702     pub fn is_multicast(&self) -> bool {
 703         self.octets()[0] >= 224 && self.octets()[0] <= 239
 704     }
 705
 706     /// Returns [`true`] if this is a broadcast address (255.255.255.255).
 707     ///
 708     /// A broadcast address has all octets set to 255 as defined in [IETF RFC 919].
 709     ///
 710     /// [IETF RFC 919]: https://tools.ietf.org/html/rfc919
 711     /// [`true`]: ../../std/primitive.bool.html
 712     ///
 713     /// # Examples
 714     ///
 715     /// ```
 716     /// use std::net::Ipv4Addr;
 717     ///
 718     /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_broadcast(), true);
 719     /// assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_broadcast(), false);
 720     /// ```
 721     #[stable(since = "1.7.0", feature = "ip_17")]
 722     pub fn is_broadcast(&self) -> bool {
 723         self == &Self::BROADCAST
 724     }
 725
 726     /// Returns [`true`] if this address is in a range designated for documentation.
 727     ///
 728     /// This is defined in [IETF RFC 5737]:
 729     ///
 730     /// - 192.0.2.0/24 (TEST-NET-1)
 731     /// - 198.51.100.0/24 (TEST-NET-2)
 732     /// - 203.0.113.0/24 (TEST-NET-3)
 733     ///
 734     /// [IETF RFC 5737]: https://tools.ietf.org/html/rfc5737
 735     /// [`true`]: ../../std/primitive.bool.html
 736     ///
 737     /// # Examples
 738     ///
 739     /// ```
 740     /// use std::net::Ipv4Addr;
 741     ///
 742     /// assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_documentation(), true);
 743     /// assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_documentation(), true);
 744     /// assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_documentation(), true);
 745     /// assert_eq!(Ipv4Addr::new(193, 34, 17, 19).is_documentation(), false);
 746     /// ```
 747     #[stable(since = "1.7.0", feature = "ip_17")]
 748     pub fn is_documentation(&self) -> bool {
 749         match self.octets() {
 750             [192, 0, 2, _] => true,
 751             [198, 51, 100, _] => true,
 752             [203, 0, 113, _] => true,
 753             _ => false,
 754         }
 755     }
 756
 757     /// Converts this address to an IPv4-compatible [IPv6 address].
 758     ///
 759     /// a.b.c.d becomes ::a.b.c.d
 760     ///
 761     /// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
 762     ///
 763     /// # Examples
 764     ///
 765     /// ```
 766     /// use std::net::{Ipv4Addr, Ipv6Addr};
 767     ///
 768     /// assert_eq!(
 769     ///     Ipv4Addr::new(192, 0, 2, 255).to_ipv6_compatible(),
 770     ///     Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 767)
 771     /// );
 772     /// ```
 773     #[stable(feature = "rust1", since = "1.0.0")]
 774     pub fn to_ipv6_compatible(&self) -> Ipv6Addr {
 775         let octets = self.octets();
 776         Ipv6Addr::from([
 777             0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, octets[0], octets[1], octets[2], octets[3],
 778         ])
 779     }
 780
 781     /// Converts this address to an IPv4-mapped [IPv6 address].
 782     ///
 783     /// a.b.c.d becomes ::ffff:a.b.c.d
 784     ///
 785     /// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
 786     ///
 787     /// # Examples
 788     ///
 789     /// ```
 790     /// use std::net::{Ipv4Addr, Ipv6Addr};
 791     ///
 792     /// assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_mapped(),
 793     ///            Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 49152, 767));
 794     /// ```
 795     #[stable(feature = "rust1", since = "1.0.0")]
 796     pub fn to_ipv6_mapped(&self) -> Ipv6Addr {
 797         let octets = self.octets();
 798         Ipv6Addr::from([
 799             0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF, octets[0], octets[1], octets[2], octets[3],
 800         ])
 801     }
 802 }
 803
 804 #[stable(feature = "ip_addr", since = "1.7.0")]
 805 impl fmt::Display for IpAddr {
 806     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
 807         match self {
 808             IpAddr::V4(ip) => ip.fmt(fmt),
 809             IpAddr::V6(ip) => ip.fmt(fmt),
 810         }
 811     }
 812 }
 813
 814 #[stable(feature = "ip_from_ip", since = "1.16.0")]
 815 impl From<Ipv4Addr> for IpAddr {
 816     fn from(ipv4: Ipv4Addr) -> IpAddr {
 817         IpAddr::V4(ipv4)
 818     }
 819 }
 820
 821 #[stable(feature = "ip_from_ip", since = "1.16.0")]
 822 impl From<Ipv6Addr> for IpAddr {
 823     fn from(ipv6: Ipv6Addr) -> IpAddr {
 824         IpAddr::V6(ipv6)
 825     }
 826 }
 827
 828 #[stable(feature = "rust1", since = "1.0.0")]
 829 impl fmt::Display for Ipv4Addr {
 830     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
 831         const IPV4_BUF_LEN: usize = 15; // Long enough for the longest possible IPv4 address
 832         let mut buf = [0u8; IPV4_BUF_LEN];
 833         let mut buf_slice = &mut buf[..];
 834         let octets = self.octets();
 835         // Note: The call to write should never fail, hence the unwrap
 836         write!(buf_slice, "{}.{}.{}.{}", octets[0], octets[1], octets[2], octets[3]).unwrap();
 837         let len = IPV4_BUF_LEN - buf_slice.len();
 838         // This unsafe is OK because we know what is being written to the buffer
 839         let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
 840         fmt.pad(buf)
 841     }
 842 }
 843
 844 #[stable(feature = "rust1", since = "1.0.0")]
 845 impl fmt::Debug for Ipv4Addr {
 846     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
 847         fmt::Display::fmt(self, fmt)
 848     }
 849 }
 850
 851 #[stable(feature = "rust1", since = "1.0.0")]
 852 impl Clone for Ipv4Addr {
 853     fn clone(&self) -> Ipv4Addr {
 854         *self
 855     }
 856 }
 857
 858 #[stable(feature = "rust1", since = "1.0.0")]
 859 impl PartialEq for Ipv4Addr {
 860     fn eq(&self, other: &Ipv4Addr) -> bool {
 861         self.inner.s_addr == other.inner.s_addr
 862     }
 863 }
 864
 865 #[stable(feature = "ip_cmp", since = "1.16.0")]
 866 impl PartialEq<Ipv4Addr> for IpAddr {
 867     fn eq(&self, other: &Ipv4Addr) -> bool {
 868         match self {
 869             IpAddr::V4(v4) => v4 == other,
 870             IpAddr::V6(_) => false,
 871         }
 872     }
 873 }
 874
 875 #[stable(feature = "ip_cmp", since = "1.16.0")]
 876 impl PartialEq<IpAddr> for Ipv4Addr {
 877     fn eq(&self, other: &IpAddr) -> bool {
 878         match other {
 879             IpAddr::V4(v4) => self == v4,
 880             IpAddr::V6(_) => false,
 881         }
 882     }
 883 }
 884
 885 #[stable(feature = "rust1", since = "1.0.0")]
 886 impl Eq for Ipv4Addr {}
 887
 888 #[stable(feature = "rust1", since = "1.0.0")]
 889 impl hash::Hash for Ipv4Addr {
 890     fn hash<H: hash::Hasher>(&self, s: &mut H) {
 891         // `inner` is #[repr(packed)], so we need to copy `s_addr`.
 892         { self.inner.s_addr }.hash(s)
 893     }
 894 }
 895
 896 #[stable(feature = "rust1", since = "1.0.0")]
 897 impl PartialOrd for Ipv4Addr {
 898     fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
 899         Some(self.cmp(other))
 900     }
 901 }
 902
 903 #[stable(feature = "ip_cmp", since = "1.16.0")]
 904 impl PartialOrd<Ipv4Addr> for IpAddr {
 905     fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
 906         match self {
 907             IpAddr::V4(v4) => v4.partial_cmp(other),
 908             IpAddr::V6(_) => Some(Ordering::Greater),
 909         }
 910     }
 911 }
 912
 913 #[stable(feature = "ip_cmp", since = "1.16.0")]
 914 impl PartialOrd<IpAddr> for Ipv4Addr {
 915     fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
 916         match other {
 917             IpAddr::V4(v4) => self.partial_cmp(v4),
 918             IpAddr::V6(_) => Some(Ordering::Less),
 919         }
 920     }
 921 }
 922
 923 #[stable(feature = "rust1", since = "1.0.0")]
 924 impl Ord for Ipv4Addr {
 925     fn cmp(&self, other: &Ipv4Addr) -> Ordering {
 926         u32::from_be(self.inner.s_addr).cmp(&u32::from_be(other.inner.s_addr))
 927     }
 928 }
 929
 930 impl AsInner<c::in_addr> for Ipv4Addr {
 931     fn as_inner(&self) -> &c::in_addr {
 932         &self.inner
 933     }
 934 }
 935 impl FromInner<c::in_addr> for Ipv4Addr {
 936     fn from_inner(addr: c::in_addr) -> Ipv4Addr {
 937         Ipv4Addr { inner: addr }
 938     }
 939 }
 940
 941 #[stable(feature = "ip_u32", since = "1.1.0")]
 942 impl From<Ipv4Addr> for u32 {
 943     /// Converts an `Ipv4Addr` into a host byte order `u32`.
 944     ///
 945     /// # Examples
 946     ///
 947     /// ```
 948     /// use std::net::Ipv4Addr;
 949     ///
 950     /// let addr = Ipv4Addr::new(13, 12, 11, 10);
 951     /// assert_eq!(0x0d0c0b0au32, u32::from(addr));
 952     /// ```
 953     fn from(ip: Ipv4Addr) -> u32 {
 954         let ip = ip.octets();
 955         u32::from_be_bytes(ip)
 956     }
 957 }
 958
 959 #[stable(feature = "ip_u32", since = "1.1.0")]
 960 impl From<u32> for Ipv4Addr {
 961     /// Converts a host byte order `u32` into an `Ipv4Addr`.
 962     ///
 963     /// # Examples
 964     ///
 965     /// ```
 966     /// use std::net::Ipv4Addr;
 967     ///
 968     /// let addr = Ipv4Addr::from(0x0d0c0b0au32);
 969     /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
 970     /// ```
 971     fn from(ip: u32) -> Ipv4Addr {
 972         Ipv4Addr::from(ip.to_be_bytes())
 973     }
 974 }
 975
 976 #[stable(feature = "from_slice_v4", since = "1.9.0")]
 977 impl From<[u8; 4]> for Ipv4Addr {
 978     /// # Examples
 979     ///
 980     /// ```
 981     /// use std::net::Ipv4Addr;
 982     ///
 983     /// let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]);
 984     /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
 985     /// ```
 986     fn from(octets: [u8; 4]) -> Ipv4Addr {
 987         Ipv4Addr::new(octets[0], octets[1], octets[2], octets[3])
 988     }
 989 }
 990
 991 #[stable(feature = "ip_from_slice", since = "1.17.0")]
 992 impl From<[u8; 4]> for IpAddr {
 993     /// Creates an `IpAddr::V4` from a four element byte array.
 994     ///
 995     /// # Examples
 996     ///
 997     /// ```
 998     /// use std::net::{IpAddr, Ipv4Addr};
 999     ///
1000     /// let addr = IpAddr::from([13u8, 12u8, 11u8, 10u8]);
1001     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(13, 12, 11, 10)), addr);
1002     /// ```
1003     fn from(octets: [u8; 4]) -> IpAddr {
1004         IpAddr::V4(Ipv4Addr::from(octets))
1005     }
1006 }
1007
1008 impl Ipv6Addr {
1009     /// Creates a new IPv6 address from eight 16-bit segments.
1010     ///
1011     /// The result will represent the IP address `a:b:c:d:e:f:g:h`.
1012     ///
1013     /// # Examples
1014     ///
1015     /// ```
1016     /// use std::net::Ipv6Addr;
1017     ///
1018     /// let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);
1019     /// ```
1020     #[stable(feature = "rust1", since = "1.0.0")]
1021     #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1022     pub const fn new(a: u16, b: u16, c: u16, d: u16, e: u16, f: u16, g: u16, h: u16) -> Ipv6Addr {
1023         Ipv6Addr {
1024             inner: c::in6_addr {
1025                 s6_addr: [
1026                     (a >> 8) as u8,
1027                     a as u8,
1028                     (b >> 8) as u8,
1029                     b as u8,
1030                     (c >> 8) as u8,
1031                     c as u8,
1032                     (d >> 8) as u8,
1033                     d as u8,
1034                     (e >> 8) as u8,
1035                     e as u8,
1036                     (f >> 8) as u8,
1037                     f as u8,
1038                     (g >> 8) as u8,
1039                     g as u8,
1040                     (h >> 8) as u8,
1041                     h as u8,
1042                 ],
1043             },
1044         }
1045     }
1046
1047     /// An IPv6 address representing localhost: `::1`.
1048     ///
1049     /// # Examples
1050     ///
1051     /// ```
1052     /// use std::net::Ipv6Addr;
1053     ///
1054     /// let addr = Ipv6Addr::LOCALHOST;
1055     /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
1056     /// ```
1057     #[stable(feature = "ip_constructors", since = "1.30.0")]
1058     pub const LOCALHOST: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
1059
1060     /// An IPv6 address representing the unspecified address: `::`
1061     ///
1062     /// # Examples
1063     ///
1064     /// ```
1065     /// use std::net::Ipv6Addr;
1066     ///
1067     /// let addr = Ipv6Addr::UNSPECIFIED;
1068     /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
1069     /// ```
1070     #[stable(feature = "ip_constructors", since = "1.30.0")]
1071     pub const UNSPECIFIED: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0);
1072
1073     /// Returns the eight 16-bit segments that make up this address.
1074     ///
1075     /// # Examples
1076     ///
1077     /// ```
1078     /// use std::net::Ipv6Addr;
1079     ///
1080     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).segments(),
1081     ///            [0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff]);
1082     /// ```
1083     #[stable(feature = "rust1", since = "1.0.0")]
1084     pub fn segments(&self) -> [u16; 8] {
1085         let arr = &self.inner.s6_addr;
1086         [
1087             u16::from_be_bytes([arr[0], arr[1]]),
1088             u16::from_be_bytes([arr[2], arr[3]]),
1089             u16::from_be_bytes([arr[4], arr[5]]),
1090             u16::from_be_bytes([arr[6], arr[7]]),
1091             u16::from_be_bytes([arr[8], arr[9]]),
1092             u16::from_be_bytes([arr[10], arr[11]]),
1093             u16::from_be_bytes([arr[12], arr[13]]),
1094             u16::from_be_bytes([arr[14], arr[15]]),
1095         ]
1096     }
1097
1098     /// Returns [`true`] for the special 'unspecified' address (::).
1099     ///
1100     /// This property is defined in [IETF RFC 4291].
1101     ///
1102     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1103     /// [`true`]: ../../std/primitive.bool.html
1104     ///
1105     /// # Examples
1106     ///
1107     /// ```
1108     /// use std::net::Ipv6Addr;
1109     ///
1110     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false);
1111     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);
1112     /// ```
1113     #[stable(since = "1.7.0", feature = "ip_17")]
1114     pub fn is_unspecified(&self) -> bool {
1115         self.segments() == [0, 0, 0, 0, 0, 0, 0, 0]
1116     }
1117
1118     /// Returns [`true`] if this is a loopback address (::1).
1119     ///
1120     /// This property is defined in [IETF RFC 4291].
1121     ///
1122     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1123     /// [`true`]: ../../std/primitive.bool.html
1124     ///
1125     /// # Examples
1126     ///
1127     /// ```
1128     /// use std::net::Ipv6Addr;
1129     ///
1130     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false);
1131     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);
1132     /// ```
1133     #[stable(since = "1.7.0", feature = "ip_17")]
1134     pub fn is_loopback(&self) -> bool {
1135         self.segments() == [0, 0, 0, 0, 0, 0, 0, 1]
1136     }
1137
1138     /// Returns [`true`] if the address appears to be globally routable.
1139     ///
1140     /// The following return [`false`]:
1141     ///
1142     /// - the loopback address
1143     /// - link-local and unique local unicast addresses
1144     /// - interface-, link-, realm-, admin- and site-local multicast addresses
1145     ///
1146     /// [`true`]: ../../std/primitive.bool.html
1147     /// [`false`]: ../../std/primitive.bool.html
1148     ///
1149     /// # Examples
1150     ///
1151     /// ```
1152     /// #![feature(ip)]
1153     ///
1154     /// use std::net::Ipv6Addr;
1155     ///
1156     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true);
1157     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false);
1158     /// assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true);
1159     /// ```
1160     pub fn is_global(&self) -> bool {
1161         match self.multicast_scope() {
1162             Some(Ipv6MulticastScope::Global) => true,
1163             None => self.is_unicast_global(),
1164             _ => false,
1165         }
1166     }
1167
1168     /// Returns [`true`] if this is a unique local address (`fc00::/7`).
1169     ///
1170     /// This property is defined in [IETF RFC 4193].
1171     ///
1172     /// [IETF RFC 4193]: https://tools.ietf.org/html/rfc4193
1173     /// [`true`]: ../../std/primitive.bool.html
1174     ///
1175     /// # Examples
1176     ///
1177     /// ```
1178     /// #![feature(ip)]
1179     ///
1180     /// use std::net::Ipv6Addr;
1181     ///
1182     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false);
1183     /// assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true);
1184     /// ```
1185     pub fn is_unique_local(&self) -> bool {
1186         (self.segments()[0] & 0xfe00) == 0xfc00
1187     }
1188
1189     /// Returns [`true`] if the address is a unicast link-local address (`fe80::/64`).
1190     ///
1191     /// A common mis-conception is to think that "unicast link-local addresses start with
1192     /// `fe80::`", but the [IETF RFC 4291] actually defines a stricter format for these addresses:
1193     ///
1194     /// ```no_rust
1195     /// |   10     |
1196     /// |  bits    |         54 bits         |          64 bits           |
1197     /// +----------+-------------------------+----------------------------+
1198     /// |1111111010|           0             |       interface ID         |
1199     /// +----------+-------------------------+----------------------------+
1200     /// ```
1201     ///
1202     /// This method validates the format defined in the RFC and won't recognize the following
1203     /// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
1204     /// If you need a less strict validation use [`is_unicast_link_local()`] instead.
1205     ///
1206     /// # Examples
1207     ///
1208     /// ```
1209     /// #![feature(ip)]
1210     ///
1211     /// use std::net::Ipv6Addr;
1212     ///
1213     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1214     /// assert!(ip.is_unicast_link_local_strict());
1215     ///
1216     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1217     /// assert!(ip.is_unicast_link_local_strict());
1218     ///
1219     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1220     /// assert!(!ip.is_unicast_link_local_strict());
1221     /// assert!(ip.is_unicast_link_local());
1222     ///
1223     /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1224     /// assert!(!ip.is_unicast_link_local_strict());
1225     /// assert!(ip.is_unicast_link_local());
1226     /// ```
1227     ///
1228     /// # See also
1229     ///
1230     /// - [IETF RFC 4291 section 2.5.6]
1231     /// - [RFC 4291 errata 4406]
1232     /// - [`is_unicast_link_local()`]
1233     ///
1234     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1235     /// [IETF RFC 4291 section 2.5.6]: https://tools.ietf.org/html/rfc4291#section-2.5.6
1236     /// [`true`]: ../../std/primitive.bool.html
1237     /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1238     /// [`is_unicast_link_local()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local
1239     ///
1240     pub fn is_unicast_link_local_strict(&self) -> bool {
1241         (self.segments()[0] & 0xffff) == 0xfe80
1242             && (self.segments()[1] & 0xffff) == 0
1243             && (self.segments()[2] & 0xffff) == 0
1244             && (self.segments()[3] & 0xffff) == 0
1245     }
1246
1247     /// Returns [`true`] if the address is a unicast link-local address (`fe80::/10`).
1248     ///
1249     /// This method returns [`true`] for addresses in the range reserved by [RFC 4291 section 2.4],
1250     /// i.e. addresses with the following format:
1251     ///
1252     /// ```no_rust
1253     /// |   10     |
1254     /// |  bits    |         54 bits         |          64 bits           |
1255     /// +----------+-------------------------+----------------------------+
1256     /// |1111111010|    arbitratry value     |       interface ID         |
1257     /// +----------+-------------------------+----------------------------+
1258     /// ```
1259     ///
1260     /// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
1261     /// unicast link-local addresses, whereas [`is_unicast_link_local_strict()`] does not. If you
1262     /// need a strict validation fully compliant with the RFC, use
1263     /// [`is_unicast_link_local_strict()`].
1264     ///
1265     /// # Examples
1266     ///
1267     /// ```
1268     /// #![feature(ip)]
1269     ///
1270     /// use std::net::Ipv6Addr;
1271     ///
1272     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1273     /// assert!(ip.is_unicast_link_local());
1274     ///
1275     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1276     /// assert!(ip.is_unicast_link_local());
1277     ///
1278     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1279     /// assert!(ip.is_unicast_link_local());
1280     /// assert!(!ip.is_unicast_link_local_strict());
1281     ///
1282     /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1283     /// assert!(ip.is_unicast_link_local());
1284     /// assert!(!ip.is_unicast_link_local_strict());
1285     /// ```
1286     ///
1287     /// # See also
1288     ///
1289     /// - [IETF RFC 4291 section 2.4]
1290     /// - [RFC 4291 errata 4406]
1291     ///
1292     /// [IETF RFC 4291 section 2.4]: https://tools.ietf.org/html/rfc4291#section-2.4
1293     /// [`true`]: ../../std/primitive.bool.html
1294     /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1295     /// [`is_unicast_link_local_strict()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local_strict
1296     ///
1297     pub fn is_unicast_link_local(&self) -> bool {
1298         (self.segments()[0] & 0xffc0) == 0xfe80
1299     }
1300
1301     /// Returns [`true`] if this is a deprecated unicast site-local address (fec0::/10). The
1302     /// unicast site-local address format is defined in [RFC 4291 section 2.5.7] as:
1303     ///
1304     /// ```no_rust
1305     /// |   10     |
1306     /// |  bits    |         54 bits         |         64 bits            |
1307     /// +----------+-------------------------+----------------------------+
1308     /// |1111111011|        subnet ID        |       interface ID         |
1309     /// +----------+-------------------------+----------------------------+
1310     /// ```
1311     ///
1312     /// [`true`]: ../../std/primitive.bool.html
1313     /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1314     ///
1315     /// # Examples
1316     ///
1317     /// ```
1318     /// #![feature(ip)]
1319     ///
1320     /// use std::net::Ipv6Addr;
1321     ///
1322     /// assert_eq!(
1323     ///     Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_site_local(),
1324     ///     false
1325     /// );
1326     /// assert_eq!(Ipv6Addr::new(0xfec2, 0, 0, 0, 0, 0, 0, 0).is_unicast_site_local(), true);
1327     /// ```
1328     ///
1329     /// # Warning
1330     ///
1331     /// As per [RFC 3879], the whole `FEC0::/10` prefix is
1332     /// deprecated. New software must not support site-local
1333     /// addresses.
1334     ///
1335     /// [RFC 3879]: https://tools.ietf.org/html/rfc3879
1336     pub fn is_unicast_site_local(&self) -> bool {
1337         (self.segments()[0] & 0xffc0) == 0xfec0
1338     }
1339
1340     /// Returns [`true`] if this is an address reserved for documentation
1341     /// (2001:db8::/32).
1342     ///
1343     /// This property is defined in [IETF RFC 3849].
1344     ///
1345     /// [IETF RFC 3849]: https://tools.ietf.org/html/rfc3849
1346     /// [`true`]: ../../std/primitive.bool.html
1347     ///
1348     /// # Examples
1349     ///
1350     /// ```
1351     /// #![feature(ip)]
1352     ///
1353     /// use std::net::Ipv6Addr;
1354     ///
1355     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false);
1356     /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true);
1357     /// ```
1358     pub fn is_documentation(&self) -> bool {
1359         (self.segments()[0] == 0x2001) && (self.segments()[1] == 0xdb8)
1360     }
1361
1362     /// Returns [`true`] if the address is a globally routable unicast address.
1363     ///
1364     /// The following return false:
1365     ///
1366     /// - the loopback address
1367     /// - the link-local addresses
1368     /// - unique local addresses
1369     /// - the unspecified address
1370     /// - the address range reserved for documentation
1371     ///
1372     /// This method returns [`true`] for site-local addresses as per [RFC 4291 section 2.5.7]
1373     ///
1374     /// ```no_rust
1375     /// The special behavior of [the site-local unicast] prefix defined in [RFC3513] must no longer
1376     /// be supported in new implementations (i.e., new implementations must treat this prefix as
1377     /// Global Unicast).
1378     /// ```
1379     ///
1380     /// [`true`]: ../../std/primitive.bool.html
1381     /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1382     ///
1383     /// # Examples
1384     ///
1385     /// ```
1386     /// #![feature(ip)]
1387     ///
1388     /// use std::net::Ipv6Addr;
1389     ///
1390     /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false);
1391     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true);
1392     /// ```
1393     pub fn is_unicast_global(&self) -> bool {
1394         !self.is_multicast()
1395             && !self.is_loopback()
1396             && !self.is_unicast_link_local()
1397             && !self.is_unique_local()
1398             && !self.is_unspecified()
1399             && !self.is_documentation()
1400     }
1401
1402     /// Returns the address's multicast scope if the address is multicast.
1403     ///
1404     /// # Examples
1405     ///
1406     /// ```
1407     /// #![feature(ip)]
1408     ///
1409     /// use std::net::{Ipv6Addr, Ipv6MulticastScope};
1410     ///
1411     /// assert_eq!(
1412     ///     Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(),
1413     ///     Some(Ipv6MulticastScope::Global)
1414     /// );
1415     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None);
1416     /// ```
1417     pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope> {
1418         if self.is_multicast() {
1419             match self.segments()[0] & 0x000f {
1420                 1 => Some(Ipv6MulticastScope::InterfaceLocal),
1421                 2 => Some(Ipv6MulticastScope::LinkLocal),
1422                 3 => Some(Ipv6MulticastScope::RealmLocal),
1423                 4 => Some(Ipv6MulticastScope::AdminLocal),
1424                 5 => Some(Ipv6MulticastScope::SiteLocal),
1425                 8 => Some(Ipv6MulticastScope::OrganizationLocal),
1426                 14 => Some(Ipv6MulticastScope::Global),
1427                 _ => None,
1428             }
1429         } else {
1430             None
1431         }
1432     }
1433
1434     /// Returns [`true`] if this is a multicast address (ff00::/8).
1435     ///
1436     /// This property is defined by [IETF RFC 4291].
1437     ///
1438     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1439     /// [`true`]: ../../std/primitive.bool.html
1440     ///
1441     /// # Examples
1442     ///
1443     /// ```
1444     /// use std::net::Ipv6Addr;
1445     ///
1446     /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true);
1447     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);
1448     /// ```
1449     #[stable(since = "1.7.0", feature = "ip_17")]
1450     pub fn is_multicast(&self) -> bool {
1451         (self.segments()[0] & 0xff00) == 0xff00
1452     }
1453
1454     /// Converts this address to an [IPv4 address]. Returns [`None`] if this address is
1455     /// neither IPv4-compatible or IPv4-mapped.
1456     ///
1457     /// ::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d
1458     ///
1459     /// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
1460     /// [`None`]: ../../std/option/enum.Option.html#variant.None
1461     ///
1462     /// # Examples
1463     ///
1464     /// ```
1465     /// use std::net::{Ipv4Addr, Ipv6Addr};
1466     ///
1467     /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None);
1468     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(),
1469     ///            Some(Ipv4Addr::new(192, 10, 2, 255)));
1470     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(),
1471     ///            Some(Ipv4Addr::new(0, 0, 0, 1)));
1472     /// ```
1473     #[stable(feature = "rust1", since = "1.0.0")]
1474     pub fn to_ipv4(&self) -> Option<Ipv4Addr> {
1475         match self.segments() {
1476             [0, 0, 0, 0, 0, f, g, h] if f == 0 || f == 0xffff => {
1477                 Some(Ipv4Addr::new((g >> 8) as u8, g as u8, (h >> 8) as u8, h as u8))
1478             }
1479             _ => None,
1480         }
1481     }
1482
1483     /// Returns the sixteen eight-bit integers the IPv6 address consists of.
1484     ///
1485     /// ```
1486     /// use std::net::Ipv6Addr;
1487     ///
1488     /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).octets(),
1489     ///            [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
1490     /// ```
1491     #[stable(feature = "ipv6_to_octets", since = "1.12.0")]
1492     #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1493     pub const fn octets(&self) -> [u8; 16] {
1494         self.inner.s6_addr
1495     }
1496 }
1497
1498 #[stable(feature = "rust1", since = "1.0.0")]
1499 impl fmt::Display for Ipv6Addr {
1500     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1501         // Note: The calls to write should never fail, hence the unwraps in the function
1502         // Long enough for the longest possible IPv6: 39
1503         const IPV6_BUF_LEN: usize = 39;
1504         let mut buf = [0u8; IPV6_BUF_LEN];
1505         let mut buf_slice = &mut buf[..];
1506
1507         match self.segments() {
1508             // We need special cases for :: and ::1, otherwise they're formatted
1509             // as ::0.0.0.[01]
1510             [0, 0, 0, 0, 0, 0, 0, 0] => write!(buf_slice, "::").unwrap(),
1511             [0, 0, 0, 0, 0, 0, 0, 1] => write!(buf_slice, "::1").unwrap(),
1512             // Ipv4 Compatible address
1513             [0, 0, 0, 0, 0, 0, g, h] => {
1514                 write!(
1515                     buf_slice,
1516                     "::{}.{}.{}.{}",
1517                     (g >> 8) as u8,
1518                     g as u8,
1519                     (h >> 8) as u8,
1520                     h as u8
1521                 )
1522                 .unwrap();
1523             }
1524             // Ipv4-Mapped address
1525             [0, 0, 0, 0, 0, 0xffff, g, h] => {
1526                 write!(
1527                     buf_slice,
1528                     "::ffff:{}.{}.{}.{}",
1529                     (g >> 8) as u8,
1530                     g as u8,
1531                     (h >> 8) as u8,
1532                     h as u8
1533                 )
1534                 .unwrap();
1535             }
1536             _ => {
1537                 fn find_zero_slice(segments: &[u16; 8]) -> (usize, usize) {
1538                     let mut longest_span_len = 0;
1539                     let mut longest_span_at = 0;
1540                     let mut cur_span_len = 0;
1541                     let mut cur_span_at = 0;
1542
1543                     for i in 0..8 {
1544                         if segments[i] == 0 {
1545                             if cur_span_len == 0 {
1546                                 cur_span_at = i;
1547                             }
1548
1549                             cur_span_len += 1;
1550
1551                             if cur_span_len > longest_span_len {
1552                                 longest_span_len = cur_span_len;
1553                                 longest_span_at = cur_span_at;
1554                             }
1555                         } else {
1556                             cur_span_len = 0;
1557                             cur_span_at = 0;
1558                         }
1559                     }
1560
1561                     (longest_span_at, longest_span_len)
1562                 }
1563
1564                 let (zeros_at, zeros_len) = find_zero_slice(&self.segments());
1565
1566                 if zeros_len > 1 {
1567                     fn fmt_subslice(segments: &[u16], buf: &mut &mut [u8]) {
1568                         if !segments.is_empty() {
1569                             write!(*buf, "{:x}", segments[0]).unwrap();
1570                             for &seg in &segments[1..] {
1571                                 write!(*buf, ":{:x}", seg).unwrap();
1572                             }
1573                         }
1574                     }
1575
1576                     fmt_subslice(&self.segments()[..zeros_at], &mut buf_slice);
1577                     write!(buf_slice, "::").unwrap();
1578                     fmt_subslice(&self.segments()[zeros_at + zeros_len..], &mut buf_slice);
1579                 } else {
1580                     let &[a, b, c, d, e, f, g, h] = &self.segments();
1581                     write!(
1582                         buf_slice,
1583                         "{:x}:{:x}:{:x}:{:x}:{:x}:{:x}:{:x}:{:x}",
1584                         a, b, c, d, e, f, g, h
1585                     )
1586                     .unwrap();
1587                 }
1588             }
1589         }
1590         let len = IPV6_BUF_LEN - buf_slice.len();
1591         // This is safe because we know exactly what can be in this buffer
1592         let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
1593         fmt.pad(buf)
1594     }
1595 }
1596
1597 #[stable(feature = "rust1", since = "1.0.0")]
1598 impl fmt::Debug for Ipv6Addr {
1599     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1600         fmt::Display::fmt(self, fmt)
1601     }
1602 }
1603
1604 #[stable(feature = "rust1", since = "1.0.0")]
1605 impl Clone for Ipv6Addr {
1606     fn clone(&self) -> Ipv6Addr {
1607         *self
1608     }
1609 }
1610
1611 #[stable(feature = "rust1", since = "1.0.0")]
1612 impl PartialEq for Ipv6Addr {
1613     fn eq(&self, other: &Ipv6Addr) -> bool {
1614         self.inner.s6_addr == other.inner.s6_addr
1615     }
1616 }
1617
1618 #[stable(feature = "ip_cmp", since = "1.16.0")]
1619 impl PartialEq<IpAddr> for Ipv6Addr {
1620     fn eq(&self, other: &IpAddr) -> bool {
1621         match other {
1622             IpAddr::V4(_) => false,
1623             IpAddr::V6(v6) => self == v6,
1624         }
1625     }
1626 }
1627
1628 #[stable(feature = "ip_cmp", since = "1.16.0")]
1629 impl PartialEq<Ipv6Addr> for IpAddr {
1630     fn eq(&self, other: &Ipv6Addr) -> bool {
1631         match self {
1632             IpAddr::V4(_) => false,
1633             IpAddr::V6(v6) => v6 == other,
1634         }
1635     }
1636 }
1637
1638 #[stable(feature = "rust1", since = "1.0.0")]
1639 impl Eq for Ipv6Addr {}
1640
1641 #[stable(feature = "rust1", since = "1.0.0")]
1642 impl hash::Hash for Ipv6Addr {
1643     fn hash<H: hash::Hasher>(&self, s: &mut H) {
1644         self.inner.s6_addr.hash(s)
1645     }
1646 }
1647
1648 #[stable(feature = "rust1", since = "1.0.0")]
1649 impl PartialOrd for Ipv6Addr {
1650     fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1651         Some(self.cmp(other))
1652     }
1653 }
1654
1655 #[stable(feature = "ip_cmp", since = "1.16.0")]
1656 impl PartialOrd<Ipv6Addr> for IpAddr {
1657     fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1658         match self {
1659             IpAddr::V4(_) => Some(Ordering::Less),
1660             IpAddr::V6(v6) => v6.partial_cmp(other),
1661         }
1662     }
1663 }
1664
1665 #[stable(feature = "ip_cmp", since = "1.16.0")]
1666 impl PartialOrd<IpAddr> for Ipv6Addr {
1667     fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
1668         match other {
1669             IpAddr::V4(_) => Some(Ordering::Greater),
1670             IpAddr::V6(v6) => self.partial_cmp(v6),
1671         }
1672     }
1673 }
1674
1675 #[stable(feature = "rust1", since = "1.0.0")]
1676 impl Ord for Ipv6Addr {
1677     fn cmp(&self, other: &Ipv6Addr) -> Ordering {
1678         self.segments().cmp(&other.segments())
1679     }
1680 }
1681
1682 impl AsInner<c::in6_addr> for Ipv6Addr {
1683     fn as_inner(&self) -> &c::in6_addr {
1684         &self.inner
1685     }
1686 }
1687 impl FromInner<c::in6_addr> for Ipv6Addr {
1688     fn from_inner(addr: c::in6_addr) -> Ipv6Addr {
1689         Ipv6Addr { inner: addr }
1690     }
1691 }
1692
1693 #[stable(feature = "i128", since = "1.26.0")]
1694 impl From<Ipv6Addr> for u128 {
1695     /// Convert an `Ipv6Addr` into a host byte order `u128`.
1696     ///
1697     /// # Examples
1698     ///
1699     /// ```
1700     /// use std::net::Ipv6Addr;
1701     ///
1702     /// let addr = Ipv6Addr::new(
1703     ///     0x1020, 0x3040, 0x5060, 0x7080,
1704     ///     0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1705     /// );
1706     /// assert_eq!(0x102030405060708090A0B0C0D0E0F00D_u128, u128::from(addr));
1707     /// ```
1708     fn from(ip: Ipv6Addr) -> u128 {
1709         let ip = ip.octets();
1710         u128::from_be_bytes(ip)
1711     }
1712 }
1713 #[stable(feature = "i128", since = "1.26.0")]
1714 impl From<u128> for Ipv6Addr {
1715     /// Convert a host byte order `u128` into an `Ipv6Addr`.
1716     ///
1717     /// # Examples
1718     ///
1719     /// ```
1720     /// use std::net::Ipv6Addr;
1721     ///
1722     /// let addr = Ipv6Addr::from(0x102030405060708090A0B0C0D0E0F00D_u128);
1723     /// assert_eq!(
1724     ///     Ipv6Addr::new(
1725     ///         0x1020, 0x3040, 0x5060, 0x7080,
1726     ///         0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1727     ///     ),
1728     ///     addr);
1729     /// ```
1730     fn from(ip: u128) -> Ipv6Addr {
1731         Ipv6Addr::from(ip.to_be_bytes())
1732     }
1733 }
1734
1735 #[stable(feature = "ipv6_from_octets", since = "1.9.0")]
1736 impl From<[u8; 16]> for Ipv6Addr {
1737     fn from(octets: [u8; 16]) -> Ipv6Addr {
1738         let inner = c::in6_addr { s6_addr: octets };
1739         Ipv6Addr::from_inner(inner)
1740     }
1741 }
1742
1743 #[stable(feature = "ipv6_from_segments", since = "1.16.0")]
1744 impl From<[u16; 8]> for Ipv6Addr {
1745     fn from(segments: [u16; 8]) -> Ipv6Addr {
1746         let [a, b, c, d, e, f, g, h] = segments;
1747         Ipv6Addr::new(a, b, c, d, e, f, g, h)
1748     }
1749 }
1750
1751 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1752 impl From<[u8; 16]> for IpAddr {
1753     /// Creates an `IpAddr::V6` from a sixteen element byte array.
1754     ///
1755     /// # Examples
1756     ///
1757     /// ```
1758     /// use std::net::{IpAddr, Ipv6Addr};
1759     ///
1760     /// let addr = IpAddr::from([
1761     ///     25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
1762     ///     17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
1763     /// ]);
1764     /// assert_eq!(
1765     ///     IpAddr::V6(Ipv6Addr::new(
1766     ///         0x1918, 0x1716,
1767     ///         0x1514, 0x1312,
1768     ///         0x1110, 0x0f0e,
1769     ///         0x0d0c, 0x0b0a
1770     ///     )),
1771     ///     addr
1772     /// );
1773     /// ```
1774     fn from(octets: [u8; 16]) -> IpAddr {
1775         IpAddr::V6(Ipv6Addr::from(octets))
1776     }
1777 }
1778
1779 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1780 impl From<[u16; 8]> for IpAddr {
1781     /// Creates an `IpAddr::V6` from an eight element 16-bit array.
1782     ///
1783     /// # Examples
1784     ///
1785     /// ```
1786     /// use std::net::{IpAddr, Ipv6Addr};
1787     ///
1788     /// let addr = IpAddr::from([
1789     ///     525u16, 524u16, 523u16, 522u16,
1790     ///     521u16, 520u16, 519u16, 518u16,
1791     /// ]);
1792     /// assert_eq!(
1793     ///     IpAddr::V6(Ipv6Addr::new(
1794     ///         0x20d, 0x20c,
1795     ///         0x20b, 0x20a,
1796     ///         0x209, 0x208,
1797     ///         0x207, 0x206
1798     ///     )),
1799     ///     addr
1800     /// );
1801     /// ```
1802     fn from(segments: [u16; 8]) -> IpAddr {
1803         IpAddr::V6(Ipv6Addr::from(segments))
1804     }
1805 }
1806
1807 // Tests for this module
1808 #[cfg(all(test, not(target_os = "emscripten")))]
1809 mod tests {
1810     use crate::net::test::{sa4, sa6, tsa};
1811     use crate::net::*;
1812     use crate::str::FromStr;
1813
1814     #[test]
1815     fn test_from_str_ipv4() {
1816         assert_eq!(Ok(Ipv4Addr::new(127, 0, 0, 1)), "127.0.0.1".parse());
1817         assert_eq!(Ok(Ipv4Addr::new(255, 255, 255, 255)), "255.255.255.255".parse());
1818         assert_eq!(Ok(Ipv4Addr::new(0, 0, 0, 0)), "0.0.0.0".parse());
1819
1820         // out of range
1821         let none: Option<Ipv4Addr> = "256.0.0.1".parse().ok();
1822         assert_eq!(None, none);
1823         // too short
1824         let none: Option<Ipv4Addr> = "255.0.0".parse().ok();
1825         assert_eq!(None, none);
1826         // too long
1827         let none: Option<Ipv4Addr> = "255.0.0.1.2".parse().ok();
1828         assert_eq!(None, none);
1829         // no number between dots
1830         let none: Option<Ipv4Addr> = "255.0..1".parse().ok();
1831         assert_eq!(None, none);
1832     }
1833
1834     #[test]
1835     fn test_from_str_ipv6() {
1836         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "0:0:0:0:0:0:0:0".parse());
1837         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "0:0:0:0:0:0:0:1".parse());
1838
1839         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "::1".parse());
1840         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "::".parse());
1841
1842         assert_eq!(
1843             Ok(Ipv6Addr::new(0x2a02, 0x6b8, 0, 0, 0, 0, 0x11, 0x11)),
1844             "2a02:6b8::11:11".parse()
1845         );
1846
1847         // too long group
1848         let none: Option<Ipv6Addr> = "::00000".parse().ok();
1849         assert_eq!(None, none);
1850         // too short
1851         let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7".parse().ok();
1852         assert_eq!(None, none);
1853         // too long
1854         let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7:8:9".parse().ok();
1855         assert_eq!(None, none);
1856         // triple colon
1857         let none: Option<Ipv6Addr> = "1:2:::6:7:8".parse().ok();
1858         assert_eq!(None, none);
1859         // two double colons
1860         let none: Option<Ipv6Addr> = "1:2::6::8".parse().ok();
1861         assert_eq!(None, none);
1862         // `::` indicating zero groups of zeros
1863         let none: Option<Ipv6Addr> = "1:2:3:4::5:6:7:8".parse().ok();
1864         assert_eq!(None, none);
1865     }
1866
1867     #[test]
1868     fn test_from_str_ipv4_in_ipv6() {
1869         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 545)), "::192.0.2.33".parse());
1870         assert_eq!(
1871             Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0xFFFF, 49152, 545)),
1872             "::FFFF:192.0.2.33".parse()
1873         );
1874         assert_eq!(
1875             Ok(Ipv6Addr::new(0x64, 0xff9b, 0, 0, 0, 0, 49152, 545)),
1876             "64:ff9b::192.0.2.33".parse()
1877         );
1878         assert_eq!(
1879             Ok(Ipv6Addr::new(0x2001, 0xdb8, 0x122, 0xc000, 0x2, 0x2100, 49152, 545)),
1880             "2001:db8:122:c000:2:2100:192.0.2.33".parse()
1881         );
1882
1883         // colon after v4
1884         let none: Option<Ipv4Addr> = "::127.0.0.1:".parse().ok();
1885         assert_eq!(None, none);
1886         // not enough groups
1887         let none: Option<Ipv6Addr> = "1.2.3.4.5:127.0.0.1".parse().ok();
1888         assert_eq!(None, none);
1889         // too many groups
1890         let none: Option<Ipv6Addr> = "1.2.3.4.5:6:7:127.0.0.1".parse().ok();
1891         assert_eq!(None, none);
1892     }
1893
1894     #[test]
1895     fn test_from_str_socket_addr() {
1896         assert_eq!(Ok(sa4(Ipv4Addr::new(77, 88, 21, 11), 80)), "77.88.21.11:80".parse());
1897         assert_eq!(
1898             Ok(SocketAddrV4::new(Ipv4Addr::new(77, 88, 21, 11), 80)),
1899             "77.88.21.11:80".parse()
1900         );
1901         assert_eq!(
1902             Ok(sa6(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53)),
1903             "[2a02:6b8:0:1::1]:53".parse()
1904         );
1905         assert_eq!(
1906             Ok(SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53, 0, 0)),
1907             "[2a02:6b8:0:1::1]:53".parse()
1908         );
1909         assert_eq!(
1910             Ok(sa6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22)),
1911             "[::127.0.0.1]:22".parse()
1912         );
1913         assert_eq!(
1914             Ok(SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22, 0, 0)),
1915             "[::127.0.0.1]:22".parse()
1916         );
1917
1918         // without port
1919         let none: Option<SocketAddr> = "127.0.0.1".parse().ok();
1920         assert_eq!(None, none);
1921         // without port
1922         let none: Option<SocketAddr> = "127.0.0.1:".parse().ok();
1923         assert_eq!(None, none);
1924         // wrong brackets around v4
1925         let none: Option<SocketAddr> = "[127.0.0.1]:22".parse().ok();
1926         assert_eq!(None, none);
1927         // port out of range
1928         let none: Option<SocketAddr> = "127.0.0.1:123456".parse().ok();
1929         assert_eq!(None, none);
1930     }
1931
1932     #[test]
1933     fn ipv4_addr_to_string() {
1934         // Short address
1935         assert_eq!(Ipv4Addr::new(1, 1, 1, 1).to_string(), "1.1.1.1");
1936         // Long address
1937         assert_eq!(Ipv4Addr::new(127, 127, 127, 127).to_string(), "127.127.127.127");
1938
1939         // Test padding
1940         assert_eq!(&format!("{:16}", Ipv4Addr::new(1, 1, 1, 1)), "1.1.1.1         ");
1941         assert_eq!(&format!("{:>16}", Ipv4Addr::new(1, 1, 1, 1)), "         1.1.1.1");
1942     }
1943
1944     #[test]
1945     fn ipv6_addr_to_string() {
1946         // ipv4-mapped address
1947         let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc000, 0x280);
1948         assert_eq!(a1.to_string(), "::ffff:192.0.2.128");
1949
1950         // ipv4-compatible address
1951         let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0xc000, 0x280);
1952         assert_eq!(a1.to_string(), "::192.0.2.128");
1953
1954         // v6 address with no zero segments
1955         assert_eq!(Ipv6Addr::new(8, 9, 10, 11, 12, 13, 14, 15).to_string(), "8:9:a:b:c:d:e:f");
1956
1957         // longest possible IPv6 length
1958         assert_eq!(
1959             Ipv6Addr::new(0x1111, 0x2222, 0x3333, 0x4444, 0x5555, 0x6666, 0x7777, 0x8888)
1960                 .to_string(),
1961             "1111:2222:3333:4444:5555:6666:7777:8888"
1962         );
1963         // padding
1964         assert_eq!(
1965             &format!("{:20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
1966             "1:2:3:4:5:6:7:8     "
1967         );
1968         assert_eq!(
1969             &format!("{:>20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
1970             "     1:2:3:4:5:6:7:8"
1971         );
1972
1973         // reduce a single run of zeros
1974         assert_eq!(
1975             "ae::ffff:102:304",
1976             Ipv6Addr::new(0xae, 0, 0, 0, 0, 0xffff, 0x0102, 0x0304).to_string()
1977         );
1978
1979         // don't reduce just a single zero segment
1980         assert_eq!("1:2:3:4:5:6:0:8", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 0, 8).to_string());
1981
1982         // 'any' address
1983         assert_eq!("::", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).to_string());
1984
1985         // loopback address
1986         assert_eq!("::1", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_string());
1987
1988         // ends in zeros
1989         assert_eq!("1::", Ipv6Addr::new(1, 0, 0, 0, 0, 0, 0, 0).to_string());
1990
1991         // two runs of zeros, second one is longer
1992         assert_eq!("1:0:0:4::8", Ipv6Addr::new(1, 0, 0, 4, 0, 0, 0, 8).to_string());
1993
1994         // two runs of zeros, equal length
1995         assert_eq!("1::4:5:0:0:8", Ipv6Addr::new(1, 0, 0, 4, 5, 0, 0, 8).to_string());
1996     }
1997
1998     #[test]
1999     fn ipv4_to_ipv6() {
2000         assert_eq!(
2001             Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678),
2002             Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_mapped()
2003         );
2004         assert_eq!(
2005             Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678),
2006             Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_compatible()
2007         );
2008     }
2009
2010     #[test]
2011     fn ipv6_to_ipv4() {
2012         assert_eq!(
2013             Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678).to_ipv4(),
2014             Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2015         );
2016         assert_eq!(
2017             Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678).to_ipv4(),
2018             Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2019         );
2020         assert_eq!(Ipv6Addr::new(0, 0, 1, 0, 0, 0, 0x1234, 0x5678).to_ipv4(), None);
2021     }
2022
2023     #[test]
2024     fn ip_properties() {
2025         macro_rules! ip {
2026             ($s:expr) => {
2027                 IpAddr::from_str($s).unwrap()
2028             };
2029         }
2030
2031         macro_rules! check {
2032             ($s:expr) => {
2033                 check!($s, 0);
2034             };
2035
2036             ($s:expr, $mask:expr) => {{
2037                 let unspec: u8 = 1 << 0;
2038                 let loopback: u8 = 1 << 1;
2039                 let global: u8 = 1 << 2;
2040                 let multicast: u8 = 1 << 3;
2041                 let doc: u8 = 1 << 4;
2042
2043                 if ($mask & unspec) == unspec {
2044                     assert!(ip!($s).is_unspecified());
2045                 } else {
2046                     assert!(!ip!($s).is_unspecified());
2047                 }
2048
2049                 if ($mask & loopback) == loopback {
2050                     assert!(ip!($s).is_loopback());
2051                 } else {
2052                     assert!(!ip!($s).is_loopback());
2053                 }
2054
2055                 if ($mask & global) == global {
2056                     assert!(ip!($s).is_global());
2057                 } else {
2058                     assert!(!ip!($s).is_global());
2059                 }
2060
2061                 if ($mask & multicast) == multicast {
2062                     assert!(ip!($s).is_multicast());
2063                 } else {
2064                     assert!(!ip!($s).is_multicast());
2065                 }
2066
2067                 if ($mask & doc) == doc {
2068                     assert!(ip!($s).is_documentation());
2069                 } else {
2070                     assert!(!ip!($s).is_documentation());
2071                 }
2072             }};
2073         }
2074
2075         let unspec: u8 = 1 << 0;
2076         let loopback: u8 = 1 << 1;
2077         let global: u8 = 1 << 2;
2078         let multicast: u8 = 1 << 3;
2079         let doc: u8 = 1 << 4;
2080
2081         check!("0.0.0.0", unspec);
2082         check!("0.0.0.1");
2083         check!("0.1.0.0");
2084         check!("10.9.8.7");
2085         check!("127.1.2.3", loopback);
2086         check!("172.31.254.253");
2087         check!("169.254.253.242");
2088         check!("192.0.2.183", doc);
2089         check!("192.1.2.183", global);
2090         check!("192.168.254.253");
2091         check!("198.51.100.0", doc);
2092         check!("203.0.113.0", doc);
2093         check!("203.2.113.0", global);
2094         check!("224.0.0.0", global | multicast);
2095         check!("239.255.255.255", global | multicast);
2096         check!("255.255.255.255");
2097         // make sure benchmarking addresses are not global
2098         check!("198.18.0.0");
2099         check!("198.18.54.2");
2100         check!("198.19.255.255");
2101         // make sure addresses reserved for protocol assignment are not global
2102         check!("192.0.0.0");
2103         check!("192.0.0.255");
2104         check!("192.0.0.100");
2105         // make sure reserved addresses are not global
2106         check!("240.0.0.0");
2107         check!("251.54.1.76");
2108         check!("254.255.255.255");
2109         // make sure shared addresses are not global
2110         check!("100.64.0.0");
2111         check!("100.127.255.255");
2112         check!("100.100.100.0");
2113
2114         check!("::", unspec);
2115         check!("::1", loopback);
2116         check!("::0.0.0.2", global);
2117         check!("1::", global);
2118         check!("fc00::");
2119         check!("fdff:ffff::");
2120         check!("fe80:ffff::");
2121         check!("febf:ffff::");
2122         check!("fec0::", global);
2123         check!("ff01::", multicast);
2124         check!("ff02::", multicast);
2125         check!("ff03::", multicast);
2126         check!("ff04::", multicast);
2127         check!("ff05::", multicast);
2128         check!("ff08::", multicast);
2129         check!("ff0e::", global | multicast);
2130         check!("2001:db8:85a3::8a2e:370:7334", doc);
2131         check!("102:304:506:708:90a:b0c:d0e:f10", global);
2132     }
2133
2134     #[test]
2135     fn ipv4_properties() {
2136         macro_rules! ip {
2137             ($s:expr) => {
2138                 Ipv4Addr::from_str($s).unwrap()
2139             };
2140         }
2141
2142         macro_rules! check {
2143             ($s:expr) => {
2144                 check!($s, 0);
2145             };
2146
2147             ($s:expr, $mask:expr) => {{
2148                 let unspec: u16 = 1 << 0;
2149                 let loopback: u16 = 1 << 1;
2150                 let private: u16 = 1 << 2;
2151                 let link_local: u16 = 1 << 3;
2152                 let global: u16 = 1 << 4;
2153                 let multicast: u16 = 1 << 5;
2154                 let broadcast: u16 = 1 << 6;
2155                 let documentation: u16 = 1 << 7;
2156                 let benchmarking: u16 = 1 << 8;
2157                 let ietf_protocol_assignment: u16 = 1 << 9;
2158                 let reserved: u16 = 1 << 10;
2159                 let shared: u16 = 1 << 11;
2160
2161                 if ($mask & unspec) == unspec {
2162                     assert!(ip!($s).is_unspecified());
2163                 } else {
2164                     assert!(!ip!($s).is_unspecified());
2165                 }
2166
2167                 if ($mask & loopback) == loopback {
2168                     assert!(ip!($s).is_loopback());
2169                 } else {
2170                     assert!(!ip!($s).is_loopback());
2171                 }
2172
2173                 if ($mask & private) == private {
2174                     assert!(ip!($s).is_private());
2175                 } else {
2176                     assert!(!ip!($s).is_private());
2177                 }
2178
2179                 if ($mask & link_local) == link_local {
2180                     assert!(ip!($s).is_link_local());
2181                 } else {
2182                     assert!(!ip!($s).is_link_local());
2183                 }
2184
2185                 if ($mask & global) == global {
2186                     assert!(ip!($s).is_global());
2187                 } else {
2188                     assert!(!ip!($s).is_global());
2189                 }
2190
2191                 if ($mask & multicast) == multicast {
2192                     assert!(ip!($s).is_multicast());
2193                 } else {
2194                     assert!(!ip!($s).is_multicast());
2195                 }
2196
2197                 if ($mask & broadcast) == broadcast {
2198                     assert!(ip!($s).is_broadcast());
2199                 } else {
2200                     assert!(!ip!($s).is_broadcast());
2201                 }
2202
2203                 if ($mask & documentation) == documentation {
2204                     assert!(ip!($s).is_documentation());
2205                 } else {
2206                     assert!(!ip!($s).is_documentation());
2207                 }
2208
2209                 if ($mask & benchmarking) == benchmarking {
2210                     assert!(ip!($s).is_benchmarking());
2211                 } else {
2212                     assert!(!ip!($s).is_benchmarking());
2213                 }
2214
2215                 if ($mask & ietf_protocol_assignment) == ietf_protocol_assignment {
2216                     assert!(ip!($s).is_ietf_protocol_assignment());
2217                 } else {
2218                     assert!(!ip!($s).is_ietf_protocol_assignment());
2219                 }
2220
2221                 if ($mask & reserved) == reserved {
2222                     assert!(ip!($s).is_reserved());
2223                 } else {
2224                     assert!(!ip!($s).is_reserved());
2225                 }
2226
2227                 if ($mask & shared) == shared {
2228                     assert!(ip!($s).is_shared());
2229                 } else {
2230                     assert!(!ip!($s).is_shared());
2231                 }
2232             }};
2233         }
2234
2235         let unspec: u16 = 1 << 0;
2236         let loopback: u16 = 1 << 1;
2237         let private: u16 = 1 << 2;
2238         let link_local: u16 = 1 << 3;
2239         let global: u16 = 1 << 4;
2240         let multicast: u16 = 1 << 5;
2241         let broadcast: u16 = 1 << 6;
2242         let documentation: u16 = 1 << 7;
2243         let benchmarking: u16 = 1 << 8;
2244         let ietf_protocol_assignment: u16 = 1 << 9;
2245         let reserved: u16 = 1 << 10;
2246         let shared: u16 = 1 << 11;
2247
2248         check!("0.0.0.0", unspec);
2249         check!("0.0.0.1");
2250         check!("0.1.0.0");
2251         check!("10.9.8.7", private);
2252         check!("127.1.2.3", loopback);
2253         check!("172.31.254.253", private);
2254         check!("169.254.253.242", link_local);
2255         check!("192.0.2.183", documentation);
2256         check!("192.1.2.183", global);
2257         check!("192.168.254.253", private);
2258         check!("198.51.100.0", documentation);
2259         check!("203.0.113.0", documentation);
2260         check!("203.2.113.0", global);
2261         check!("224.0.0.0", global | multicast);
2262         check!("239.255.255.255", global | multicast);
2263         check!("255.255.255.255", broadcast);
2264         check!("198.18.0.0", benchmarking);
2265         check!("198.18.54.2", benchmarking);
2266         check!("198.19.255.255", benchmarking);
2267         check!("192.0.0.0", ietf_protocol_assignment);
2268         check!("192.0.0.255", ietf_protocol_assignment);
2269         check!("192.0.0.100", ietf_protocol_assignment);
2270         check!("240.0.0.0", reserved);
2271         check!("251.54.1.76", reserved);
2272         check!("254.255.255.255", reserved);
2273         check!("100.64.0.0", shared);
2274         check!("100.127.255.255", shared);
2275         check!("100.100.100.0", shared);
2276     }
2277
2278     #[test]
2279     fn ipv6_properties() {
2280         macro_rules! ip {
2281             ($s:expr) => {
2282                 Ipv6Addr::from_str($s).unwrap()
2283             };
2284         }
2285
2286         macro_rules! check {
2287             ($s:expr, &[$($octet:expr),*], $mask:expr) => {
2288                 assert_eq!($s, ip!($s).to_string());
2289                 let octets = &[$($octet),*];
2290                 assert_eq!(&ip!($s).octets(), octets);
2291                 assert_eq!(Ipv6Addr::from(*octets), ip!($s));
2292
2293                 let unspecified: u16 = 1 << 0;
2294                 let loopback: u16 = 1 << 1;
2295                 let unique_local: u16 = 1 << 2;
2296                 let global: u16 = 1 << 3;
2297                 let unicast_link_local: u16 = 1 << 4;
2298                 let unicast_link_local_strict: u16 = 1 << 5;
2299                 let unicast_site_local: u16 = 1 << 6;
2300                 let unicast_global: u16 = 1 << 7;
2301                 let documentation: u16 = 1 << 8;
2302                 let multicast_interface_local: u16 = 1 << 9;
2303                 let multicast_link_local: u16 = 1 << 10;
2304                 let multicast_realm_local: u16 = 1 << 11;
2305                 let multicast_admin_local: u16 = 1 << 12;
2306                 let multicast_site_local: u16 = 1 << 13;
2307                 let multicast_organization_local: u16 = 1 << 14;
2308                 let multicast_global: u16 = 1 << 15;
2309                 let multicast: u16 = multicast_interface_local
2310                     | multicast_admin_local
2311                     | multicast_global
2312                     | multicast_link_local
2313                     | multicast_realm_local
2314                     | multicast_site_local
2315                     | multicast_organization_local;
2316
2317                 if ($mask & unspecified) == unspecified {
2318                     assert!(ip!($s).is_unspecified());
2319                 } else {
2320                     assert!(!ip!($s).is_unspecified());
2321                 }
2322                 if ($mask & loopback) == loopback {
2323                     assert!(ip!($s).is_loopback());
2324                 } else {
2325                     assert!(!ip!($s).is_loopback());
2326                 }
2327                 if ($mask & unique_local) == unique_local {
2328                     assert!(ip!($s).is_unique_local());
2329                 } else {
2330                     assert!(!ip!($s).is_unique_local());
2331                 }
2332                 if ($mask & global) == global {
2333                     assert!(ip!($s).is_global());
2334                 } else {
2335                     assert!(!ip!($s).is_global());
2336                 }
2337                 if ($mask & unicast_link_local) == unicast_link_local {
2338                     assert!(ip!($s).is_unicast_link_local());
2339                 } else {
2340                     assert!(!ip!($s).is_unicast_link_local());
2341                 }
2342                 if ($mask & unicast_link_local_strict) == unicast_link_local_strict {
2343                     assert!(ip!($s).is_unicast_link_local_strict());
2344                 } else {
2345                     assert!(!ip!($s).is_unicast_link_local_strict());
2346                 }
2347                 if ($mask & unicast_site_local) == unicast_site_local {
2348                     assert!(ip!($s).is_unicast_site_local());
2349                 } else {
2350                     assert!(!ip!($s).is_unicast_site_local());
2351                 }
2352                 if ($mask & unicast_global) == unicast_global {
2353                     assert!(ip!($s).is_unicast_global());
2354                 } else {
2355                     assert!(!ip!($s).is_unicast_global());
2356                 }
2357                 if ($mask & documentation) == documentation {
2358                     assert!(ip!($s).is_documentation());
2359                 } else {
2360                     assert!(!ip!($s).is_documentation());
2361                 }
2362                 if ($mask & multicast) != 0 {
2363                     assert!(ip!($s).multicast_scope().is_some());
2364                     assert!(ip!($s).is_multicast());
2365                 } else {
2366                     assert!(ip!($s).multicast_scope().is_none());
2367                     assert!(!ip!($s).is_multicast());
2368                 }
2369                 if ($mask & multicast_interface_local) == multicast_interface_local {
2370                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2371                                Ipv6MulticastScope::InterfaceLocal);
2372                 }
2373                 if ($mask & multicast_link_local) == multicast_link_local {
2374                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2375                                Ipv6MulticastScope::LinkLocal);
2376                 }
2377                 if ($mask & multicast_realm_local) == multicast_realm_local {
2378                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2379                                Ipv6MulticastScope::RealmLocal);
2380                 }
2381                 if ($mask & multicast_admin_local) == multicast_admin_local {
2382                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2383                                Ipv6MulticastScope::AdminLocal);
2384                 }
2385                 if ($mask & multicast_site_local) == multicast_site_local {
2386                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2387                                Ipv6MulticastScope::SiteLocal);
2388                 }
2389                 if ($mask & multicast_organization_local) == multicast_organization_local {
2390                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2391                                Ipv6MulticastScope::OrganizationLocal);
2392                 }
2393                 if ($mask & multicast_global) == multicast_global {
2394                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2395                                Ipv6MulticastScope::Global);
2396                 }
2397             }
2398         }
2399
2400         let unspecified: u16 = 1 << 0;
2401         let loopback: u16 = 1 << 1;
2402         let unique_local: u16 = 1 << 2;
2403         let global: u16 = 1 << 3;
2404         let unicast_link_local: u16 = 1 << 4;
2405         let unicast_link_local_strict: u16 = 1 << 5;
2406         let unicast_site_local: u16 = 1 << 6;
2407         let unicast_global: u16 = 1 << 7;
2408         let documentation: u16 = 1 << 8;
2409         let multicast_interface_local: u16 = 1 << 9;
2410         let multicast_link_local: u16 = 1 << 10;
2411         let multicast_realm_local: u16 = 1 << 11;
2412         let multicast_admin_local: u16 = 1 << 12;
2413         let multicast_site_local: u16 = 1 << 13;
2414         let multicast_organization_local: u16 = 1 << 14;
2415         let multicast_global: u16 = 1 << 15;
2416
2417         check!("::", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unspecified);
2418
2419         check!("::1", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1], loopback);
2420
2421         check!(
2422             "::0.0.0.2",
2423             &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2],
2424             global | unicast_global
2425         );
2426
2427         check!("1::", &[0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], global | unicast_global);
2428
2429         check!("fc00::", &[0xfc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unique_local);
2430
2431         check!(
2432             "fdff:ffff::",
2433             &[0xfd, 0xff, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2434             unique_local
2435         );
2436
2437         check!(
2438             "fe80:ffff::",
2439             &[0xfe, 0x80, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2440             unicast_link_local
2441         );
2442
2443         check!(
2444             "fe80::",
2445             &[0xfe, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2446             unicast_link_local | unicast_link_local_strict
2447         );
2448
2449         check!(
2450             "febf:ffff::",
2451             &[0xfe, 0xbf, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2452             unicast_link_local
2453         );
2454
2455         check!(
2456             "febf::",
2457             &[0xfe, 0xbf, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2458             unicast_link_local
2459         );
2460
2461         check!(
2462             "febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
2463             &[
2464                 0xfe, 0xbf, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2465                 0xff, 0xff
2466             ],
2467             unicast_link_local
2468         );
2469
2470         check!(
2471             "fe80::ffff:ffff:ffff:ffff",
2472             &[
2473                 0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2474                 0xff, 0xff
2475             ],
2476             unicast_link_local | unicast_link_local_strict
2477         );
2478
2479         check!(
2480             "fe80:0:0:1::",
2481             &[0xfe, 0x80, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
2482             unicast_link_local
2483         );
2484
2485         check!(
2486             "fec0::",
2487             &[0xfe, 0xc0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2488             unicast_site_local | unicast_global | global
2489         );
2490
2491         check!(
2492             "ff01::",
2493             &[0xff, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2494             multicast_interface_local
2495         );
2496
2497         check!(
2498             "ff02::",
2499             &[0xff, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2500             multicast_link_local
2501         );
2502
2503         check!(
2504             "ff03::",
2505             &[0xff, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2506             multicast_realm_local
2507         );
2508
2509         check!(
2510             "ff04::",
2511             &[0xff, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2512             multicast_admin_local
2513         );
2514
2515         check!(
2516             "ff05::",
2517             &[0xff, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2518             multicast_site_local
2519         );
2520
2521         check!(
2522             "ff08::",
2523             &[0xff, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2524             multicast_organization_local
2525         );
2526
2527         check!(
2528             "ff0e::",
2529             &[0xff, 0xe, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2530             multicast_global | global
2531         );
2532
2533         check!(
2534             "2001:db8:85a3::8a2e:370:7334",
2535             &[0x20, 1, 0xd, 0xb8, 0x85, 0xa3, 0, 0, 0, 0, 0x8a, 0x2e, 3, 0x70, 0x73, 0x34],
2536             documentation
2537         );
2538
2539         check!(
2540             "102:304:506:708:90a:b0c:d0e:f10",
2541             &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16],
2542             global | unicast_global
2543         );
2544     }
2545
2546     #[test]
2547     fn to_socket_addr_socketaddr() {
2548         let a = sa4(Ipv4Addr::new(77, 88, 21, 11), 12345);
2549         assert_eq!(Ok(vec![a]), tsa(a));
2550     }
2551
2552     #[test]
2553     fn test_ipv4_to_int() {
2554         let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2555         assert_eq!(u32::from(a), 0x11223344);
2556     }
2557
2558     #[test]
2559     fn test_int_to_ipv4() {
2560         let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2561         assert_eq!(Ipv4Addr::from(0x11223344), a);
2562     }
2563
2564     #[test]
2565     fn test_ipv6_to_int() {
2566         let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2567         assert_eq!(u128::from(a), 0x112233445566778899aabbccddeeff11u128);
2568     }
2569
2570     #[test]
2571     fn test_int_to_ipv6() {
2572         let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2573         assert_eq!(Ipv6Addr::from(0x112233445566778899aabbccddeeff11u128), a);
2574     }
2575
2576     #[test]
2577     fn ipv4_from_constructors() {
2578         assert_eq!(Ipv4Addr::LOCALHOST, Ipv4Addr::new(127, 0, 0, 1));
2579         assert!(Ipv4Addr::LOCALHOST.is_loopback());
2580         assert_eq!(Ipv4Addr::UNSPECIFIED, Ipv4Addr::new(0, 0, 0, 0));
2581         assert!(Ipv4Addr::UNSPECIFIED.is_unspecified());
2582         assert_eq!(Ipv4Addr::BROADCAST, Ipv4Addr::new(255, 255, 255, 255));
2583         assert!(Ipv4Addr::BROADCAST.is_broadcast());
2584     }
2585
2586     #[test]
2587     fn ipv6_from_contructors() {
2588         assert_eq!(Ipv6Addr::LOCALHOST, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
2589         assert!(Ipv6Addr::LOCALHOST.is_loopback());
2590         assert_eq!(Ipv6Addr::UNSPECIFIED, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
2591         assert!(Ipv6Addr::UNSPECIFIED.is_unspecified());
2592     }
2593
2594     #[test]
2595     fn ipv4_from_octets() {
2596         assert_eq!(Ipv4Addr::from([127, 0, 0, 1]), Ipv4Addr::new(127, 0, 0, 1))
2597     }
2598
2599     #[test]
2600     fn ipv6_from_segments() {
2601         let from_u16s =
2602             Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2603         let new = Ipv6Addr::new(0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff);
2604         assert_eq!(new, from_u16s);
2605     }
2606
2607     #[test]
2608     fn ipv6_from_octets() {
2609         let from_u16s =
2610             Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2611         let from_u8s = Ipv6Addr::from([
2612             0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd,
2613             0xee, 0xff,
2614         ]);
2615         assert_eq!(from_u16s, from_u8s);
2616     }
2617
2618     #[test]
2619     fn cmp() {
2620         let v41 = Ipv4Addr::new(100, 64, 3, 3);
2621         let v42 = Ipv4Addr::new(192, 0, 2, 2);
2622         let v61 = "2001:db8:f00::1002".parse::<Ipv6Addr>().unwrap();
2623         let v62 = "2001:db8:f00::2001".parse::<Ipv6Addr>().unwrap();
2624         assert!(v41 < v42);
2625         assert!(v61 < v62);
2626
2627         assert_eq!(v41, IpAddr::V4(v41));
2628         assert_eq!(v61, IpAddr::V6(v61));
2629         assert!(v41 != IpAddr::V4(v42));
2630         assert!(v61 != IpAddr::V6(v62));
2631
2632         assert!(v41 < IpAddr::V4(v42));
2633         assert!(v61 < IpAddr::V6(v62));
2634         assert!(IpAddr::V4(v41) < v42);
2635         assert!(IpAddr::V6(v61) < v62);
2636
2637         assert!(v41 < IpAddr::V6(v61));
2638         assert!(IpAddr::V4(v41) < v61);
2639     }
2640
2641     #[test]
2642     fn is_v4() {
2643         let ip = IpAddr::V4(Ipv4Addr::new(100, 64, 3, 3));
2644         assert!(ip.is_ipv4());
2645         assert!(!ip.is_ipv6());
2646     }
2647
2648     #[test]
2649     fn is_v6() {
2650         let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678));
2651         assert!(!ip.is_ipv4());
2652         assert!(ip.is_ipv6());
2653     }
2654 }