library/std/src/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::{self, Write as FmtWrite};
  11 use crate::hash;
  12 use crate::io::Write as IoWrite;
  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 explicitly 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     /// Copies this address to a new `IpAddr::V4`.
 817     ///
 818     /// # Examples
 819     ///
 820     /// ```
 821     /// use std::net::{IpAddr, Ipv4Addr};
 822     ///
 823     /// let addr = Ipv4Addr::new(127, 0, 0, 1);
 824     ///
 825     /// assert_eq!(
 826     ///     IpAddr::V4(addr),
 827     ///     IpAddr::from(addr)
 828     /// )
 829     /// ```
 830     fn from(ipv4: Ipv4Addr) -> IpAddr {
 831         IpAddr::V4(ipv4)
 832     }
 833 }
 834
 835 #[stable(feature = "ip_from_ip", since = "1.16.0")]
 836 impl From<Ipv6Addr> for IpAddr {
 837     /// Copies this address to a new `IpAddr::V6`.
 838     ///
 839     /// # Examples
 840     ///
 841     /// ```
 842     /// use std::net::{IpAddr, Ipv6Addr};
 843     ///
 844     /// let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);
 845     ///
 846     /// assert_eq!(
 847     ///     IpAddr::V6(addr),
 848     ///     IpAddr::from(addr)
 849     /// );
 850     /// ```
 851     fn from(ipv6: Ipv6Addr) -> IpAddr {
 852         IpAddr::V6(ipv6)
 853     }
 854 }
 855
 856 #[stable(feature = "rust1", since = "1.0.0")]
 857 impl fmt::Display for Ipv4Addr {
 858     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
 859         let octets = self.octets();
 860         // Fast Path: if there's no alignment stuff, write directly to the buffer
 861         if fmt.precision().is_none() && fmt.width().is_none() {
 862             write!(fmt, "{}.{}.{}.{}", octets[0], octets[1], octets[2], octets[3])
 863         } else {
 864             const IPV4_BUF_LEN: usize = 15; // Long enough for the longest possible IPv4 address
 865             let mut buf = [0u8; IPV4_BUF_LEN];
 866             let mut buf_slice = &mut buf[..];
 867
 868             // Note: The call to write should never fail, hence the unwrap
 869             write!(buf_slice, "{}.{}.{}.{}", octets[0], octets[1], octets[2], octets[3]).unwrap();
 870             let len = IPV4_BUF_LEN - buf_slice.len();
 871
 872             // This unsafe is OK because we know what is being written to the buffer
 873             let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
 874             fmt.pad(buf)
 875         }
 876     }
 877 }
 878
 879 #[stable(feature = "rust1", since = "1.0.0")]
 880 impl fmt::Debug for Ipv4Addr {
 881     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
 882         fmt::Display::fmt(self, fmt)
 883     }
 884 }
 885
 886 #[stable(feature = "rust1", since = "1.0.0")]
 887 impl Clone for Ipv4Addr {
 888     fn clone(&self) -> Ipv4Addr {
 889         *self
 890     }
 891 }
 892
 893 #[stable(feature = "rust1", since = "1.0.0")]
 894 impl PartialEq for Ipv4Addr {
 895     fn eq(&self, other: &Ipv4Addr) -> bool {
 896         self.inner.s_addr == other.inner.s_addr
 897     }
 898 }
 899
 900 #[stable(feature = "ip_cmp", since = "1.16.0")]
 901 impl PartialEq<Ipv4Addr> for IpAddr {
 902     fn eq(&self, other: &Ipv4Addr) -> bool {
 903         match self {
 904             IpAddr::V4(v4) => v4 == other,
 905             IpAddr::V6(_) => false,
 906         }
 907     }
 908 }
 909
 910 #[stable(feature = "ip_cmp", since = "1.16.0")]
 911 impl PartialEq<IpAddr> for Ipv4Addr {
 912     fn eq(&self, other: &IpAddr) -> bool {
 913         match other {
 914             IpAddr::V4(v4) => self == v4,
 915             IpAddr::V6(_) => false,
 916         }
 917     }
 918 }
 919
 920 #[stable(feature = "rust1", since = "1.0.0")]
 921 impl Eq for Ipv4Addr {}
 922
 923 #[stable(feature = "rust1", since = "1.0.0")]
 924 impl hash::Hash for Ipv4Addr {
 925     fn hash<H: hash::Hasher>(&self, s: &mut H) {
 926         // `inner` is #[repr(packed)], so we need to copy `s_addr`.
 927         { self.inner.s_addr }.hash(s)
 928     }
 929 }
 930
 931 #[stable(feature = "rust1", since = "1.0.0")]
 932 impl PartialOrd for Ipv4Addr {
 933     fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
 934         Some(self.cmp(other))
 935     }
 936 }
 937
 938 #[stable(feature = "ip_cmp", since = "1.16.0")]
 939 impl PartialOrd<Ipv4Addr> for IpAddr {
 940     fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
 941         match self {
 942             IpAddr::V4(v4) => v4.partial_cmp(other),
 943             IpAddr::V6(_) => Some(Ordering::Greater),
 944         }
 945     }
 946 }
 947
 948 #[stable(feature = "ip_cmp", since = "1.16.0")]
 949 impl PartialOrd<IpAddr> for Ipv4Addr {
 950     fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
 951         match other {
 952             IpAddr::V4(v4) => self.partial_cmp(v4),
 953             IpAddr::V6(_) => Some(Ordering::Less),
 954         }
 955     }
 956 }
 957
 958 #[stable(feature = "rust1", since = "1.0.0")]
 959 impl Ord for Ipv4Addr {
 960     fn cmp(&self, other: &Ipv4Addr) -> Ordering {
 961         u32::from_be(self.inner.s_addr).cmp(&u32::from_be(other.inner.s_addr))
 962     }
 963 }
 964
 965 impl AsInner<c::in_addr> for Ipv4Addr {
 966     fn as_inner(&self) -> &c::in_addr {
 967         &self.inner
 968     }
 969 }
 970 impl FromInner<c::in_addr> for Ipv4Addr {
 971     fn from_inner(addr: c::in_addr) -> Ipv4Addr {
 972         Ipv4Addr { inner: addr }
 973     }
 974 }
 975
 976 #[stable(feature = "ip_u32", since = "1.1.0")]
 977 impl From<Ipv4Addr> for u32 {
 978     /// Converts an `Ipv4Addr` into a host byte order `u32`.
 979     ///
 980     /// # Examples
 981     ///
 982     /// ```
 983     /// use std::net::Ipv4Addr;
 984     ///
 985     /// let addr = Ipv4Addr::new(13, 12, 11, 10);
 986     /// assert_eq!(0x0d0c0b0au32, u32::from(addr));
 987     /// ```
 988     fn from(ip: Ipv4Addr) -> u32 {
 989         let ip = ip.octets();
 990         u32::from_be_bytes(ip)
 991     }
 992 }
 993
 994 #[stable(feature = "ip_u32", since = "1.1.0")]
 995 impl From<u32> for Ipv4Addr {
 996     /// Converts a host byte order `u32` into an `Ipv4Addr`.
 997     ///
 998     /// # Examples
 999     ///
1000     /// ```
1001     /// use std::net::Ipv4Addr;
1002     ///
1003     /// let addr = Ipv4Addr::from(0x0d0c0b0au32);
1004     /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
1005     /// ```
1006     fn from(ip: u32) -> Ipv4Addr {
1007         Ipv4Addr::from(ip.to_be_bytes())
1008     }
1009 }
1010
1011 #[stable(feature = "from_slice_v4", since = "1.9.0")]
1012 impl From<[u8; 4]> for Ipv4Addr {
1013     /// Creates an `Ipv4Addr` from a four element byte array.
1014     ///
1015     /// # Examples
1016     ///
1017     /// ```
1018     /// use std::net::Ipv4Addr;
1019     ///
1020     /// let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]);
1021     /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
1022     /// ```
1023     fn from(octets: [u8; 4]) -> Ipv4Addr {
1024         Ipv4Addr::new(octets[0], octets[1], octets[2], octets[3])
1025     }
1026 }
1027
1028 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1029 impl From<[u8; 4]> for IpAddr {
1030     /// Creates an `IpAddr::V4` from a four element byte array.
1031     ///
1032     /// # Examples
1033     ///
1034     /// ```
1035     /// use std::net::{IpAddr, Ipv4Addr};
1036     ///
1037     /// let addr = IpAddr::from([13u8, 12u8, 11u8, 10u8]);
1038     /// assert_eq!(IpAddr::V4(Ipv4Addr::new(13, 12, 11, 10)), addr);
1039     /// ```
1040     fn from(octets: [u8; 4]) -> IpAddr {
1041         IpAddr::V4(Ipv4Addr::from(octets))
1042     }
1043 }
1044
1045 impl Ipv6Addr {
1046     /// Creates a new IPv6 address from eight 16-bit segments.
1047     ///
1048     /// The result will represent the IP address `a:b:c:d:e:f:g:h`.
1049     ///
1050     /// # Examples
1051     ///
1052     /// ```
1053     /// use std::net::Ipv6Addr;
1054     ///
1055     /// let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);
1056     /// ```
1057     #[stable(feature = "rust1", since = "1.0.0")]
1058     #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1059     pub const fn new(a: u16, b: u16, c: u16, d: u16, e: u16, f: u16, g: u16, h: u16) -> Ipv6Addr {
1060         Ipv6Addr {
1061             inner: c::in6_addr {
1062                 s6_addr: [
1063                     (a >> 8) as u8,
1064                     a as u8,
1065                     (b >> 8) as u8,
1066                     b as u8,
1067                     (c >> 8) as u8,
1068                     c as u8,
1069                     (d >> 8) as u8,
1070                     d as u8,
1071                     (e >> 8) as u8,
1072                     e as u8,
1073                     (f >> 8) as u8,
1074                     f as u8,
1075                     (g >> 8) as u8,
1076                     g as u8,
1077                     (h >> 8) as u8,
1078                     h as u8,
1079                 ],
1080             },
1081         }
1082     }
1083
1084     /// An IPv6 address representing localhost: `::1`.
1085     ///
1086     /// # Examples
1087     ///
1088     /// ```
1089     /// use std::net::Ipv6Addr;
1090     ///
1091     /// let addr = Ipv6Addr::LOCALHOST;
1092     /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
1093     /// ```
1094     #[stable(feature = "ip_constructors", since = "1.30.0")]
1095     pub const LOCALHOST: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
1096
1097     /// An IPv6 address representing the unspecified address: `::`
1098     ///
1099     /// # Examples
1100     ///
1101     /// ```
1102     /// use std::net::Ipv6Addr;
1103     ///
1104     /// let addr = Ipv6Addr::UNSPECIFIED;
1105     /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
1106     /// ```
1107     #[stable(feature = "ip_constructors", since = "1.30.0")]
1108     pub const UNSPECIFIED: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0);
1109
1110     /// Returns the eight 16-bit segments that make up this address.
1111     ///
1112     /// # Examples
1113     ///
1114     /// ```
1115     /// use std::net::Ipv6Addr;
1116     ///
1117     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).segments(),
1118     ///            [0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff]);
1119     /// ```
1120     #[stable(feature = "rust1", since = "1.0.0")]
1121     pub fn segments(&self) -> [u16; 8] {
1122         let arr = &self.inner.s6_addr;
1123         [
1124             u16::from_be_bytes([arr[0], arr[1]]),
1125             u16::from_be_bytes([arr[2], arr[3]]),
1126             u16::from_be_bytes([arr[4], arr[5]]),
1127             u16::from_be_bytes([arr[6], arr[7]]),
1128             u16::from_be_bytes([arr[8], arr[9]]),
1129             u16::from_be_bytes([arr[10], arr[11]]),
1130             u16::from_be_bytes([arr[12], arr[13]]),
1131             u16::from_be_bytes([arr[14], arr[15]]),
1132         ]
1133     }
1134
1135     /// Returns [`true`] for the special 'unspecified' address (::).
1136     ///
1137     /// This property is defined in [IETF RFC 4291].
1138     ///
1139     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1140     /// [`true`]: ../../std/primitive.bool.html
1141     ///
1142     /// # Examples
1143     ///
1144     /// ```
1145     /// use std::net::Ipv6Addr;
1146     ///
1147     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false);
1148     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);
1149     /// ```
1150     #[stable(since = "1.7.0", feature = "ip_17")]
1151     pub fn is_unspecified(&self) -> bool {
1152         self.segments() == [0, 0, 0, 0, 0, 0, 0, 0]
1153     }
1154
1155     /// Returns [`true`] if this is a loopback address (::1).
1156     ///
1157     /// This property is defined in [IETF RFC 4291].
1158     ///
1159     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1160     /// [`true`]: ../../std/primitive.bool.html
1161     ///
1162     /// # Examples
1163     ///
1164     /// ```
1165     /// use std::net::Ipv6Addr;
1166     ///
1167     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false);
1168     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);
1169     /// ```
1170     #[stable(since = "1.7.0", feature = "ip_17")]
1171     pub fn is_loopback(&self) -> bool {
1172         self.segments() == [0, 0, 0, 0, 0, 0, 0, 1]
1173     }
1174
1175     /// Returns [`true`] if the address appears to be globally routable.
1176     ///
1177     /// The following return [`false`]:
1178     ///
1179     /// - the loopback address
1180     /// - link-local and unique local unicast addresses
1181     /// - interface-, link-, realm-, admin- and site-local multicast addresses
1182     ///
1183     /// [`true`]: ../../std/primitive.bool.html
1184     /// [`false`]: ../../std/primitive.bool.html
1185     ///
1186     /// # Examples
1187     ///
1188     /// ```
1189     /// #![feature(ip)]
1190     ///
1191     /// use std::net::Ipv6Addr;
1192     ///
1193     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true);
1194     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false);
1195     /// assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true);
1196     /// ```
1197     pub fn is_global(&self) -> bool {
1198         match self.multicast_scope() {
1199             Some(Ipv6MulticastScope::Global) => true,
1200             None => self.is_unicast_global(),
1201             _ => false,
1202         }
1203     }
1204
1205     /// Returns [`true`] if this is a unique local address (`fc00::/7`).
1206     ///
1207     /// This property is defined in [IETF RFC 4193].
1208     ///
1209     /// [IETF RFC 4193]: https://tools.ietf.org/html/rfc4193
1210     /// [`true`]: ../../std/primitive.bool.html
1211     ///
1212     /// # Examples
1213     ///
1214     /// ```
1215     /// #![feature(ip)]
1216     ///
1217     /// use std::net::Ipv6Addr;
1218     ///
1219     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false);
1220     /// assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true);
1221     /// ```
1222     pub fn is_unique_local(&self) -> bool {
1223         (self.segments()[0] & 0xfe00) == 0xfc00
1224     }
1225
1226     /// Returns [`true`] if the address is a unicast link-local address (`fe80::/64`).
1227     ///
1228     /// A common mis-conception is to think that "unicast link-local addresses start with
1229     /// `fe80::`", but the [IETF RFC 4291] actually defines a stricter format for these addresses:
1230     ///
1231     /// ```no_rust
1232     /// |   10     |
1233     /// |  bits    |         54 bits         |          64 bits           |
1234     /// +----------+-------------------------+----------------------------+
1235     /// |1111111010|           0             |       interface ID         |
1236     /// +----------+-------------------------+----------------------------+
1237     /// ```
1238     ///
1239     /// This method validates the format defined in the RFC and won't recognize the following
1240     /// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
1241     /// If you need a less strict validation use [`is_unicast_link_local()`] instead.
1242     ///
1243     /// # Examples
1244     ///
1245     /// ```
1246     /// #![feature(ip)]
1247     ///
1248     /// use std::net::Ipv6Addr;
1249     ///
1250     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1251     /// assert!(ip.is_unicast_link_local_strict());
1252     ///
1253     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1254     /// assert!(ip.is_unicast_link_local_strict());
1255     ///
1256     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1257     /// assert!(!ip.is_unicast_link_local_strict());
1258     /// assert!(ip.is_unicast_link_local());
1259     ///
1260     /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1261     /// assert!(!ip.is_unicast_link_local_strict());
1262     /// assert!(ip.is_unicast_link_local());
1263     /// ```
1264     ///
1265     /// # See also
1266     ///
1267     /// - [IETF RFC 4291 section 2.5.6]
1268     /// - [RFC 4291 errata 4406] (which has been rejected but provides useful
1269     ///   insight)
1270     /// - [`is_unicast_link_local()`]
1271     ///
1272     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1273     /// [IETF RFC 4291 section 2.5.6]: https://tools.ietf.org/html/rfc4291#section-2.5.6
1274     /// [`true`]: ../../std/primitive.bool.html
1275     /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1276     /// [`is_unicast_link_local()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local
1277     pub fn is_unicast_link_local_strict(&self) -> bool {
1278         (self.segments()[0] & 0xffff) == 0xfe80
1279             && (self.segments()[1] & 0xffff) == 0
1280             && (self.segments()[2] & 0xffff) == 0
1281             && (self.segments()[3] & 0xffff) == 0
1282     }
1283
1284     /// Returns [`true`] if the address is a unicast link-local address (`fe80::/10`).
1285     ///
1286     /// This method returns [`true`] for addresses in the range reserved by [RFC 4291 section 2.4],
1287     /// i.e. addresses with the following format:
1288     ///
1289     /// ```no_rust
1290     /// |   10     |
1291     /// |  bits    |         54 bits         |          64 bits           |
1292     /// +----------+-------------------------+----------------------------+
1293     /// |1111111010|    arbitratry value     |       interface ID         |
1294     /// +----------+-------------------------+----------------------------+
1295     /// ```
1296     ///
1297     /// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
1298     /// unicast link-local addresses, whereas [`is_unicast_link_local_strict()`] does not. If you
1299     /// need a strict validation fully compliant with the RFC, use
1300     /// [`is_unicast_link_local_strict()`].
1301     ///
1302     /// # Examples
1303     ///
1304     /// ```
1305     /// #![feature(ip)]
1306     ///
1307     /// use std::net::Ipv6Addr;
1308     ///
1309     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1310     /// assert!(ip.is_unicast_link_local());
1311     ///
1312     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1313     /// assert!(ip.is_unicast_link_local());
1314     ///
1315     /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1316     /// assert!(ip.is_unicast_link_local());
1317     /// assert!(!ip.is_unicast_link_local_strict());
1318     ///
1319     /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1320     /// assert!(ip.is_unicast_link_local());
1321     /// assert!(!ip.is_unicast_link_local_strict());
1322     /// ```
1323     ///
1324     /// # See also
1325     ///
1326     /// - [IETF RFC 4291 section 2.4]
1327     /// - [RFC 4291 errata 4406] (which has been rejected but provides useful
1328     ///   insight)
1329     ///
1330     /// [IETF RFC 4291 section 2.4]: https://tools.ietf.org/html/rfc4291#section-2.4
1331     /// [`true`]: ../../std/primitive.bool.html
1332     /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1333     /// [`is_unicast_link_local_strict()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local_strict
1334     pub fn is_unicast_link_local(&self) -> bool {
1335         (self.segments()[0] & 0xffc0) == 0xfe80
1336     }
1337
1338     /// Returns [`true`] if this is a deprecated unicast site-local address (fec0::/10). The
1339     /// unicast site-local address format is defined in [RFC 4291 section 2.5.7] as:
1340     ///
1341     /// ```no_rust
1342     /// |   10     |
1343     /// |  bits    |         54 bits         |         64 bits            |
1344     /// +----------+-------------------------+----------------------------+
1345     /// |1111111011|        subnet ID        |       interface ID         |
1346     /// +----------+-------------------------+----------------------------+
1347     /// ```
1348     ///
1349     /// [`true`]: ../../std/primitive.bool.html
1350     /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1351     ///
1352     /// # Examples
1353     ///
1354     /// ```
1355     /// #![feature(ip)]
1356     ///
1357     /// use std::net::Ipv6Addr;
1358     ///
1359     /// assert_eq!(
1360     ///     Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_site_local(),
1361     ///     false
1362     /// );
1363     /// assert_eq!(Ipv6Addr::new(0xfec2, 0, 0, 0, 0, 0, 0, 0).is_unicast_site_local(), true);
1364     /// ```
1365     ///
1366     /// # Warning
1367     ///
1368     /// As per [RFC 3879], the whole `FEC0::/10` prefix is
1369     /// deprecated. New software must not support site-local
1370     /// addresses.
1371     ///
1372     /// [RFC 3879]: https://tools.ietf.org/html/rfc3879
1373     pub fn is_unicast_site_local(&self) -> bool {
1374         (self.segments()[0] & 0xffc0) == 0xfec0
1375     }
1376
1377     /// Returns [`true`] if this is an address reserved for documentation
1378     /// (2001:db8::/32).
1379     ///
1380     /// This property is defined in [IETF RFC 3849].
1381     ///
1382     /// [IETF RFC 3849]: https://tools.ietf.org/html/rfc3849
1383     /// [`true`]: ../../std/primitive.bool.html
1384     ///
1385     /// # Examples
1386     ///
1387     /// ```
1388     /// #![feature(ip)]
1389     ///
1390     /// use std::net::Ipv6Addr;
1391     ///
1392     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false);
1393     /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true);
1394     /// ```
1395     pub fn is_documentation(&self) -> bool {
1396         (self.segments()[0] == 0x2001) && (self.segments()[1] == 0xdb8)
1397     }
1398
1399     /// Returns [`true`] if the address is a globally routable unicast address.
1400     ///
1401     /// The following return false:
1402     ///
1403     /// - the loopback address
1404     /// - the link-local addresses
1405     /// - unique local addresses
1406     /// - the unspecified address
1407     /// - the address range reserved for documentation
1408     ///
1409     /// This method returns [`true`] for site-local addresses as per [RFC 4291 section 2.5.7]
1410     ///
1411     /// ```no_rust
1412     /// The special behavior of [the site-local unicast] prefix defined in [RFC3513] must no longer
1413     /// be supported in new implementations (i.e., new implementations must treat this prefix as
1414     /// Global Unicast).
1415     /// ```
1416     ///
1417     /// [`true`]: ../../std/primitive.bool.html
1418     /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1419     ///
1420     /// # Examples
1421     ///
1422     /// ```
1423     /// #![feature(ip)]
1424     ///
1425     /// use std::net::Ipv6Addr;
1426     ///
1427     /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false);
1428     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true);
1429     /// ```
1430     pub fn is_unicast_global(&self) -> bool {
1431         !self.is_multicast()
1432             && !self.is_loopback()
1433             && !self.is_unicast_link_local()
1434             && !self.is_unique_local()
1435             && !self.is_unspecified()
1436             && !self.is_documentation()
1437     }
1438
1439     /// Returns the address's multicast scope if the address is multicast.
1440     ///
1441     /// # Examples
1442     ///
1443     /// ```
1444     /// #![feature(ip)]
1445     ///
1446     /// use std::net::{Ipv6Addr, Ipv6MulticastScope};
1447     ///
1448     /// assert_eq!(
1449     ///     Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(),
1450     ///     Some(Ipv6MulticastScope::Global)
1451     /// );
1452     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None);
1453     /// ```
1454     pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope> {
1455         if self.is_multicast() {
1456             match self.segments()[0] & 0x000f {
1457                 1 => Some(Ipv6MulticastScope::InterfaceLocal),
1458                 2 => Some(Ipv6MulticastScope::LinkLocal),
1459                 3 => Some(Ipv6MulticastScope::RealmLocal),
1460                 4 => Some(Ipv6MulticastScope::AdminLocal),
1461                 5 => Some(Ipv6MulticastScope::SiteLocal),
1462                 8 => Some(Ipv6MulticastScope::OrganizationLocal),
1463                 14 => Some(Ipv6MulticastScope::Global),
1464                 _ => None,
1465             }
1466         } else {
1467             None
1468         }
1469     }
1470
1471     /// Returns [`true`] if this is a multicast address (ff00::/8).
1472     ///
1473     /// This property is defined by [IETF RFC 4291].
1474     ///
1475     /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1476     /// [`true`]: ../../std/primitive.bool.html
1477     ///
1478     /// # Examples
1479     ///
1480     /// ```
1481     /// use std::net::Ipv6Addr;
1482     ///
1483     /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true);
1484     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);
1485     /// ```
1486     #[stable(since = "1.7.0", feature = "ip_17")]
1487     pub fn is_multicast(&self) -> bool {
1488         (self.segments()[0] & 0xff00) == 0xff00
1489     }
1490
1491     /// Converts this address to an [IPv4 address]. Returns [`None`] if this address is
1492     /// neither IPv4-compatible or IPv4-mapped.
1493     ///
1494     /// ::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d
1495     ///
1496     /// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
1497     /// [`None`]: ../../std/option/enum.Option.html#variant.None
1498     ///
1499     /// # Examples
1500     ///
1501     /// ```
1502     /// use std::net::{Ipv4Addr, Ipv6Addr};
1503     ///
1504     /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None);
1505     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(),
1506     ///            Some(Ipv4Addr::new(192, 10, 2, 255)));
1507     /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(),
1508     ///            Some(Ipv4Addr::new(0, 0, 0, 1)));
1509     /// ```
1510     #[stable(feature = "rust1", since = "1.0.0")]
1511     pub fn to_ipv4(&self) -> Option<Ipv4Addr> {
1512         match self.segments() {
1513             [0, 0, 0, 0, 0, f, g, h] if f == 0 || f == 0xffff => {
1514                 Some(Ipv4Addr::new((g >> 8) as u8, g as u8, (h >> 8) as u8, h as u8))
1515             }
1516             _ => None,
1517         }
1518     }
1519
1520     /// Returns the sixteen eight-bit integers the IPv6 address consists of.
1521     ///
1522     /// ```
1523     /// use std::net::Ipv6Addr;
1524     ///
1525     /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).octets(),
1526     ///            [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
1527     /// ```
1528     #[stable(feature = "ipv6_to_octets", since = "1.12.0")]
1529     #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1530     pub const fn octets(&self) -> [u8; 16] {
1531         self.inner.s6_addr
1532     }
1533 }
1534
1535 /// Write an Ipv6Addr, conforming to the canonical style described by
1536 /// [RFC 5952](https://tools.ietf.org/html/rfc5952).
1537 #[stable(feature = "rust1", since = "1.0.0")]
1538 impl fmt::Display for Ipv6Addr {
1539     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1540         // If there are no alignment requirements, write out the IP address to
1541         // f. Otherwise, write it to a local buffer, then use f.pad.
1542         if f.precision().is_none() && f.width().is_none() {
1543             let segments = self.segments();
1544
1545             // Special case for :: and ::1; otherwise they get written with the
1546             // IPv4 formatter
1547             if self.is_unspecified() {
1548                 f.write_str("::")
1549             } else if self.is_loopback() {
1550                 f.write_str("::1")
1551             } else if let Some(ipv4) = self.to_ipv4() {
1552                 match segments[5] {
1553                     // IPv4 Compatible address
1554                     0 => write!(f, "::{}", ipv4),
1555                     // IPv4 Mapped address
1556                     0xffff => write!(f, "::ffff:{}", ipv4),
1557                     _ => unreachable!(),
1558                 }
1559             } else {
1560                 #[derive(Copy, Clone, Default)]
1561                 struct Span {
1562                     start: usize,
1563                     len: usize,
1564                 }
1565
1566                 // Find the inner 0 span
1567                 let zeroes = {
1568                     let mut longest = Span::default();
1569                     let mut current = Span::default();
1570
1571                     for (i, &segment) in segments.iter().enumerate() {
1572                         if segment == 0 {
1573                             if current.len == 0 {
1574                                 current.start = i;
1575                             }
1576
1577                             current.len += 1;
1578
1579                             if current.len > longest.len {
1580                                 longest = current;
1581                             }
1582                         } else {
1583                             current = Span::default();
1584                         }
1585                     }
1586
1587                     longest
1588                 };
1589
1590                 /// Write a colon-separated part of the address
1591                 #[inline]
1592                 fn fmt_subslice(f: &mut fmt::Formatter<'_>, chunk: &[u16]) -> fmt::Result {
1593                     if let Some(first) = chunk.first() {
1594                         fmt::LowerHex::fmt(first, f)?;
1595                         for segment in &chunk[1..] {
1596                             f.write_char(':')?;
1597                             fmt::LowerHex::fmt(segment, f)?;
1598                         }
1599                     }
1600                     Ok(())
1601                 }
1602
1603                 if zeroes.len > 1 {
1604                     fmt_subslice(f, &segments[..zeroes.start])?;
1605                     f.write_str("::")?;
1606                     fmt_subslice(f, &segments[zeroes.start + zeroes.len..])
1607                 } else {
1608                     fmt_subslice(f, &segments)
1609                 }
1610             }
1611         } else {
1612             // Slow path: write the address to a local buffer, the use f.pad.
1613             // Defined recursively by using the fast path to write to the
1614             // buffer.
1615
1616             // This is the largest possible size of an IPv6 address
1617             const IPV6_BUF_LEN: usize = (4 * 8) + 7;
1618             let mut buf = [0u8; IPV6_BUF_LEN];
1619             let mut buf_slice = &mut buf[..];
1620
1621             // Note: This call to write should never fail, so unwrap is okay.
1622             write!(buf_slice, "{}", self).unwrap();
1623             let len = IPV6_BUF_LEN - buf_slice.len();
1624
1625             // This is safe because we know exactly what can be in this buffer
1626             let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
1627             f.pad(buf)
1628         }
1629     }
1630 }
1631
1632 #[stable(feature = "rust1", since = "1.0.0")]
1633 impl fmt::Debug for Ipv6Addr {
1634     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1635         fmt::Display::fmt(self, fmt)
1636     }
1637 }
1638
1639 #[stable(feature = "rust1", since = "1.0.0")]
1640 impl Clone for Ipv6Addr {
1641     fn clone(&self) -> Ipv6Addr {
1642         *self
1643     }
1644 }
1645
1646 #[stable(feature = "rust1", since = "1.0.0")]
1647 impl PartialEq for Ipv6Addr {
1648     fn eq(&self, other: &Ipv6Addr) -> bool {
1649         self.inner.s6_addr == other.inner.s6_addr
1650     }
1651 }
1652
1653 #[stable(feature = "ip_cmp", since = "1.16.0")]
1654 impl PartialEq<IpAddr> for Ipv6Addr {
1655     fn eq(&self, other: &IpAddr) -> bool {
1656         match other {
1657             IpAddr::V4(_) => false,
1658             IpAddr::V6(v6) => self == v6,
1659         }
1660     }
1661 }
1662
1663 #[stable(feature = "ip_cmp", since = "1.16.0")]
1664 impl PartialEq<Ipv6Addr> for IpAddr {
1665     fn eq(&self, other: &Ipv6Addr) -> bool {
1666         match self {
1667             IpAddr::V4(_) => false,
1668             IpAddr::V6(v6) => v6 == other,
1669         }
1670     }
1671 }
1672
1673 #[stable(feature = "rust1", since = "1.0.0")]
1674 impl Eq for Ipv6Addr {}
1675
1676 #[stable(feature = "rust1", since = "1.0.0")]
1677 impl hash::Hash for Ipv6Addr {
1678     fn hash<H: hash::Hasher>(&self, s: &mut H) {
1679         self.inner.s6_addr.hash(s)
1680     }
1681 }
1682
1683 #[stable(feature = "rust1", since = "1.0.0")]
1684 impl PartialOrd for Ipv6Addr {
1685     fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1686         Some(self.cmp(other))
1687     }
1688 }
1689
1690 #[stable(feature = "ip_cmp", since = "1.16.0")]
1691 impl PartialOrd<Ipv6Addr> for IpAddr {
1692     fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1693         match self {
1694             IpAddr::V4(_) => Some(Ordering::Less),
1695             IpAddr::V6(v6) => v6.partial_cmp(other),
1696         }
1697     }
1698 }
1699
1700 #[stable(feature = "ip_cmp", since = "1.16.0")]
1701 impl PartialOrd<IpAddr> for Ipv6Addr {
1702     fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
1703         match other {
1704             IpAddr::V4(_) => Some(Ordering::Greater),
1705             IpAddr::V6(v6) => self.partial_cmp(v6),
1706         }
1707     }
1708 }
1709
1710 #[stable(feature = "rust1", since = "1.0.0")]
1711 impl Ord for Ipv6Addr {
1712     fn cmp(&self, other: &Ipv6Addr) -> Ordering {
1713         self.segments().cmp(&other.segments())
1714     }
1715 }
1716
1717 impl AsInner<c::in6_addr> for Ipv6Addr {
1718     fn as_inner(&self) -> &c::in6_addr {
1719         &self.inner
1720     }
1721 }
1722 impl FromInner<c::in6_addr> for Ipv6Addr {
1723     fn from_inner(addr: c::in6_addr) -> Ipv6Addr {
1724         Ipv6Addr { inner: addr }
1725     }
1726 }
1727
1728 #[stable(feature = "i128", since = "1.26.0")]
1729 impl From<Ipv6Addr> for u128 {
1730     /// Convert an `Ipv6Addr` into a host byte order `u128`.
1731     ///
1732     /// # Examples
1733     ///
1734     /// ```
1735     /// use std::net::Ipv6Addr;
1736     ///
1737     /// let addr = Ipv6Addr::new(
1738     ///     0x1020, 0x3040, 0x5060, 0x7080,
1739     ///     0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1740     /// );
1741     /// assert_eq!(0x102030405060708090A0B0C0D0E0F00D_u128, u128::from(addr));
1742     /// ```
1743     fn from(ip: Ipv6Addr) -> u128 {
1744         let ip = ip.octets();
1745         u128::from_be_bytes(ip)
1746     }
1747 }
1748 #[stable(feature = "i128", since = "1.26.0")]
1749 impl From<u128> for Ipv6Addr {
1750     /// Convert a host byte order `u128` into an `Ipv6Addr`.
1751     ///
1752     /// # Examples
1753     ///
1754     /// ```
1755     /// use std::net::Ipv6Addr;
1756     ///
1757     /// let addr = Ipv6Addr::from(0x102030405060708090A0B0C0D0E0F00D_u128);
1758     /// assert_eq!(
1759     ///     Ipv6Addr::new(
1760     ///         0x1020, 0x3040, 0x5060, 0x7080,
1761     ///         0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1762     ///     ),
1763     ///     addr);
1764     /// ```
1765     fn from(ip: u128) -> Ipv6Addr {
1766         Ipv6Addr::from(ip.to_be_bytes())
1767     }
1768 }
1769
1770 #[stable(feature = "ipv6_from_octets", since = "1.9.0")]
1771 impl From<[u8; 16]> for Ipv6Addr {
1772     /// Creates an `Ipv6Addr` from a sixteen element byte array.
1773     ///
1774     /// # Examples
1775     ///
1776     /// ```
1777     /// use std::net::Ipv6Addr;
1778     ///
1779     /// let addr = Ipv6Addr::from([
1780     ///     25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
1781     ///     17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
1782     /// ]);
1783     /// assert_eq!(
1784     ///     Ipv6Addr::new(
1785     ///         0x1918, 0x1716,
1786     ///         0x1514, 0x1312,
1787     ///         0x1110, 0x0f0e,
1788     ///         0x0d0c, 0x0b0a
1789     ///     ),
1790     ///     addr
1791     /// );
1792     /// ```
1793     fn from(octets: [u8; 16]) -> Ipv6Addr {
1794         let inner = c::in6_addr { s6_addr: octets };
1795         Ipv6Addr::from_inner(inner)
1796     }
1797 }
1798
1799 #[stable(feature = "ipv6_from_segments", since = "1.16.0")]
1800 impl From<[u16; 8]> for Ipv6Addr {
1801     /// Creates an `Ipv6Addr` from an eight element 16-bit array.
1802     ///
1803     /// # Examples
1804     ///
1805     /// ```
1806     /// use std::net::Ipv6Addr;
1807     ///
1808     /// let addr = Ipv6Addr::from([
1809     ///     525u16, 524u16, 523u16, 522u16,
1810     ///     521u16, 520u16, 519u16, 518u16,
1811     /// ]);
1812     /// assert_eq!(
1813     ///     Ipv6Addr::new(
1814     ///         0x20d, 0x20c,
1815     ///         0x20b, 0x20a,
1816     ///         0x209, 0x208,
1817     ///         0x207, 0x206
1818     ///     ),
1819     ///     addr
1820     /// );
1821     /// ```
1822     fn from(segments: [u16; 8]) -> Ipv6Addr {
1823         let [a, b, c, d, e, f, g, h] = segments;
1824         Ipv6Addr::new(a, b, c, d, e, f, g, h)
1825     }
1826 }
1827
1828 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1829 impl From<[u8; 16]> for IpAddr {
1830     /// Creates an `IpAddr::V6` from a sixteen element byte array.
1831     ///
1832     /// # Examples
1833     ///
1834     /// ```
1835     /// use std::net::{IpAddr, Ipv6Addr};
1836     ///
1837     /// let addr = IpAddr::from([
1838     ///     25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
1839     ///     17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
1840     /// ]);
1841     /// assert_eq!(
1842     ///     IpAddr::V6(Ipv6Addr::new(
1843     ///         0x1918, 0x1716,
1844     ///         0x1514, 0x1312,
1845     ///         0x1110, 0x0f0e,
1846     ///         0x0d0c, 0x0b0a
1847     ///     )),
1848     ///     addr
1849     /// );
1850     /// ```
1851     fn from(octets: [u8; 16]) -> IpAddr {
1852         IpAddr::V6(Ipv6Addr::from(octets))
1853     }
1854 }
1855
1856 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1857 impl From<[u16; 8]> for IpAddr {
1858     /// Creates an `IpAddr::V6` from an eight element 16-bit array.
1859     ///
1860     /// # Examples
1861     ///
1862     /// ```
1863     /// use std::net::{IpAddr, Ipv6Addr};
1864     ///
1865     /// let addr = IpAddr::from([
1866     ///     525u16, 524u16, 523u16, 522u16,
1867     ///     521u16, 520u16, 519u16, 518u16,
1868     /// ]);
1869     /// assert_eq!(
1870     ///     IpAddr::V6(Ipv6Addr::new(
1871     ///         0x20d, 0x20c,
1872     ///         0x20b, 0x20a,
1873     ///         0x209, 0x208,
1874     ///         0x207, 0x206
1875     ///     )),
1876     ///     addr
1877     /// );
1878     /// ```
1879     fn from(segments: [u16; 8]) -> IpAddr {
1880         IpAddr::V6(Ipv6Addr::from(segments))
1881     }
1882 }
1883
1884 // Tests for this module
1885 #[cfg(all(test, not(target_os = "emscripten")))]
1886 mod tests {
1887     use crate::net::test::{sa4, sa6, tsa};
1888     use crate::net::*;
1889     use crate::str::FromStr;
1890
1891     #[test]
1892     fn test_from_str_ipv4() {
1893         assert_eq!(Ok(Ipv4Addr::new(127, 0, 0, 1)), "127.0.0.1".parse());
1894         assert_eq!(Ok(Ipv4Addr::new(255, 255, 255, 255)), "255.255.255.255".parse());
1895         assert_eq!(Ok(Ipv4Addr::new(0, 0, 0, 0)), "0.0.0.0".parse());
1896
1897         // out of range
1898         let none: Option<Ipv4Addr> = "256.0.0.1".parse().ok();
1899         assert_eq!(None, none);
1900         // too short
1901         let none: Option<Ipv4Addr> = "255.0.0".parse().ok();
1902         assert_eq!(None, none);
1903         // too long
1904         let none: Option<Ipv4Addr> = "255.0.0.1.2".parse().ok();
1905         assert_eq!(None, none);
1906         // no number between dots
1907         let none: Option<Ipv4Addr> = "255.0..1".parse().ok();
1908         assert_eq!(None, none);
1909     }
1910
1911     #[test]
1912     fn test_from_str_ipv6() {
1913         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "0:0:0:0:0:0:0:0".parse());
1914         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "0:0:0:0:0:0:0:1".parse());
1915
1916         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "::1".parse());
1917         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "::".parse());
1918
1919         assert_eq!(
1920             Ok(Ipv6Addr::new(0x2a02, 0x6b8, 0, 0, 0, 0, 0x11, 0x11)),
1921             "2a02:6b8::11:11".parse()
1922         );
1923
1924         // too long group
1925         let none: Option<Ipv6Addr> = "::00000".parse().ok();
1926         assert_eq!(None, none);
1927         // too short
1928         let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7".parse().ok();
1929         assert_eq!(None, none);
1930         // too long
1931         let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7:8:9".parse().ok();
1932         assert_eq!(None, none);
1933         // triple colon
1934         let none: Option<Ipv6Addr> = "1:2:::6:7:8".parse().ok();
1935         assert_eq!(None, none);
1936         // two double colons
1937         let none: Option<Ipv6Addr> = "1:2::6::8".parse().ok();
1938         assert_eq!(None, none);
1939         // `::` indicating zero groups of zeros
1940         let none: Option<Ipv6Addr> = "1:2:3:4::5:6:7:8".parse().ok();
1941         assert_eq!(None, none);
1942     }
1943
1944     #[test]
1945     fn test_from_str_ipv4_in_ipv6() {
1946         assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 545)), "::192.0.2.33".parse());
1947         assert_eq!(
1948             Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0xFFFF, 49152, 545)),
1949             "::FFFF:192.0.2.33".parse()
1950         );
1951         assert_eq!(
1952             Ok(Ipv6Addr::new(0x64, 0xff9b, 0, 0, 0, 0, 49152, 545)),
1953             "64:ff9b::192.0.2.33".parse()
1954         );
1955         assert_eq!(
1956             Ok(Ipv6Addr::new(0x2001, 0xdb8, 0x122, 0xc000, 0x2, 0x2100, 49152, 545)),
1957             "2001:db8:122:c000:2:2100:192.0.2.33".parse()
1958         );
1959
1960         // colon after v4
1961         let none: Option<Ipv4Addr> = "::127.0.0.1:".parse().ok();
1962         assert_eq!(None, none);
1963         // not enough groups
1964         let none: Option<Ipv6Addr> = "1.2.3.4.5:127.0.0.1".parse().ok();
1965         assert_eq!(None, none);
1966         // too many groups
1967         let none: Option<Ipv6Addr> = "1.2.3.4.5:6:7:127.0.0.1".parse().ok();
1968         assert_eq!(None, none);
1969     }
1970
1971     #[test]
1972     fn test_from_str_socket_addr() {
1973         assert_eq!(Ok(sa4(Ipv4Addr::new(77, 88, 21, 11), 80)), "77.88.21.11:80".parse());
1974         assert_eq!(
1975             Ok(SocketAddrV4::new(Ipv4Addr::new(77, 88, 21, 11), 80)),
1976             "77.88.21.11:80".parse()
1977         );
1978         assert_eq!(
1979             Ok(sa6(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53)),
1980             "[2a02:6b8:0:1::1]:53".parse()
1981         );
1982         assert_eq!(
1983             Ok(SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53, 0, 0)),
1984             "[2a02:6b8:0:1::1]:53".parse()
1985         );
1986         assert_eq!(
1987             Ok(sa6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22)),
1988             "[::127.0.0.1]:22".parse()
1989         );
1990         assert_eq!(
1991             Ok(SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22, 0, 0)),
1992             "[::127.0.0.1]:22".parse()
1993         );
1994
1995         // without port
1996         let none: Option<SocketAddr> = "127.0.0.1".parse().ok();
1997         assert_eq!(None, none);
1998         // without port
1999         let none: Option<SocketAddr> = "127.0.0.1:".parse().ok();
2000         assert_eq!(None, none);
2001         // wrong brackets around v4
2002         let none: Option<SocketAddr> = "[127.0.0.1]:22".parse().ok();
2003         assert_eq!(None, none);
2004         // port out of range
2005         let none: Option<SocketAddr> = "127.0.0.1:123456".parse().ok();
2006         assert_eq!(None, none);
2007     }
2008
2009     #[test]
2010     fn ipv4_addr_to_string() {
2011         // Short address
2012         assert_eq!(Ipv4Addr::new(1, 1, 1, 1).to_string(), "1.1.1.1");
2013         // Long address
2014         assert_eq!(Ipv4Addr::new(127, 127, 127, 127).to_string(), "127.127.127.127");
2015
2016         // Test padding
2017         assert_eq!(&format!("{:16}", Ipv4Addr::new(1, 1, 1, 1)), "1.1.1.1         ");
2018         assert_eq!(&format!("{:>16}", Ipv4Addr::new(1, 1, 1, 1)), "         1.1.1.1");
2019     }
2020
2021     #[test]
2022     fn ipv6_addr_to_string() {
2023         // ipv4-mapped address
2024         let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc000, 0x280);
2025         assert_eq!(a1.to_string(), "::ffff:192.0.2.128");
2026
2027         // ipv4-compatible address
2028         let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0xc000, 0x280);
2029         assert_eq!(a1.to_string(), "::192.0.2.128");
2030
2031         // v6 address with no zero segments
2032         assert_eq!(Ipv6Addr::new(8, 9, 10, 11, 12, 13, 14, 15).to_string(), "8:9:a:b:c:d:e:f");
2033
2034         // longest possible IPv6 length
2035         assert_eq!(
2036             Ipv6Addr::new(0x1111, 0x2222, 0x3333, 0x4444, 0x5555, 0x6666, 0x7777, 0x8888)
2037                 .to_string(),
2038             "1111:2222:3333:4444:5555:6666:7777:8888"
2039         );
2040         // padding
2041         assert_eq!(
2042             &format!("{:20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
2043             "1:2:3:4:5:6:7:8     "
2044         );
2045         assert_eq!(
2046             &format!("{:>20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
2047             "     1:2:3:4:5:6:7:8"
2048         );
2049
2050         // reduce a single run of zeros
2051         assert_eq!(
2052             "ae::ffff:102:304",
2053             Ipv6Addr::new(0xae, 0, 0, 0, 0, 0xffff, 0x0102, 0x0304).to_string()
2054         );
2055
2056         // don't reduce just a single zero segment
2057         assert_eq!("1:2:3:4:5:6:0:8", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 0, 8).to_string());
2058
2059         // 'any' address
2060         assert_eq!("::", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).to_string());
2061
2062         // loopback address
2063         assert_eq!("::1", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_string());
2064
2065         // ends in zeros
2066         assert_eq!("1::", Ipv6Addr::new(1, 0, 0, 0, 0, 0, 0, 0).to_string());
2067
2068         // two runs of zeros, second one is longer
2069         assert_eq!("1:0:0:4::8", Ipv6Addr::new(1, 0, 0, 4, 0, 0, 0, 8).to_string());
2070
2071         // two runs of zeros, equal length
2072         assert_eq!("1::4:5:0:0:8", Ipv6Addr::new(1, 0, 0, 4, 5, 0, 0, 8).to_string());
2073     }
2074
2075     #[test]
2076     fn ipv4_to_ipv6() {
2077         assert_eq!(
2078             Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678),
2079             Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_mapped()
2080         );
2081         assert_eq!(
2082             Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678),
2083             Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_compatible()
2084         );
2085     }
2086
2087     #[test]
2088     fn ipv6_to_ipv4() {
2089         assert_eq!(
2090             Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678).to_ipv4(),
2091             Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2092         );
2093         assert_eq!(
2094             Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678).to_ipv4(),
2095             Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2096         );
2097         assert_eq!(Ipv6Addr::new(0, 0, 1, 0, 0, 0, 0x1234, 0x5678).to_ipv4(), None);
2098     }
2099
2100     #[test]
2101     fn ip_properties() {
2102         macro_rules! ip {
2103             ($s:expr) => {
2104                 IpAddr::from_str($s).unwrap()
2105             };
2106         }
2107
2108         macro_rules! check {
2109             ($s:expr) => {
2110                 check!($s, 0);
2111             };
2112
2113             ($s:expr, $mask:expr) => {{
2114                 let unspec: u8 = 1 << 0;
2115                 let loopback: u8 = 1 << 1;
2116                 let global: u8 = 1 << 2;
2117                 let multicast: u8 = 1 << 3;
2118                 let doc: u8 = 1 << 4;
2119
2120                 if ($mask & unspec) == unspec {
2121                     assert!(ip!($s).is_unspecified());
2122                 } else {
2123                     assert!(!ip!($s).is_unspecified());
2124                 }
2125
2126                 if ($mask & loopback) == loopback {
2127                     assert!(ip!($s).is_loopback());
2128                 } else {
2129                     assert!(!ip!($s).is_loopback());
2130                 }
2131
2132                 if ($mask & global) == global {
2133                     assert!(ip!($s).is_global());
2134                 } else {
2135                     assert!(!ip!($s).is_global());
2136                 }
2137
2138                 if ($mask & multicast) == multicast {
2139                     assert!(ip!($s).is_multicast());
2140                 } else {
2141                     assert!(!ip!($s).is_multicast());
2142                 }
2143
2144                 if ($mask & doc) == doc {
2145                     assert!(ip!($s).is_documentation());
2146                 } else {
2147                     assert!(!ip!($s).is_documentation());
2148                 }
2149             }};
2150         }
2151
2152         let unspec: u8 = 1 << 0;
2153         let loopback: u8 = 1 << 1;
2154         let global: u8 = 1 << 2;
2155         let multicast: u8 = 1 << 3;
2156         let doc: u8 = 1 << 4;
2157
2158         check!("0.0.0.0", unspec);
2159         check!("0.0.0.1");
2160         check!("0.1.0.0");
2161         check!("10.9.8.7");
2162         check!("127.1.2.3", loopback);
2163         check!("172.31.254.253");
2164         check!("169.254.253.242");
2165         check!("192.0.2.183", doc);
2166         check!("192.1.2.183", global);
2167         check!("192.168.254.253");
2168         check!("198.51.100.0", doc);
2169         check!("203.0.113.0", doc);
2170         check!("203.2.113.0", global);
2171         check!("224.0.0.0", global | multicast);
2172         check!("239.255.255.255", global | multicast);
2173         check!("255.255.255.255");
2174         // make sure benchmarking addresses are not global
2175         check!("198.18.0.0");
2176         check!("198.18.54.2");
2177         check!("198.19.255.255");
2178         // make sure addresses reserved for protocol assignment are not global
2179         check!("192.0.0.0");
2180         check!("192.0.0.255");
2181         check!("192.0.0.100");
2182         // make sure reserved addresses are not global
2183         check!("240.0.0.0");
2184         check!("251.54.1.76");
2185         check!("254.255.255.255");
2186         // make sure shared addresses are not global
2187         check!("100.64.0.0");
2188         check!("100.127.255.255");
2189         check!("100.100.100.0");
2190
2191         check!("::", unspec);
2192         check!("::1", loopback);
2193         check!("::0.0.0.2", global);
2194         check!("1::", global);
2195         check!("fc00::");
2196         check!("fdff:ffff::");
2197         check!("fe80:ffff::");
2198         check!("febf:ffff::");
2199         check!("fec0::", global);
2200         check!("ff01::", multicast);
2201         check!("ff02::", multicast);
2202         check!("ff03::", multicast);
2203         check!("ff04::", multicast);
2204         check!("ff05::", multicast);
2205         check!("ff08::", multicast);
2206         check!("ff0e::", global | multicast);
2207         check!("2001:db8:85a3::8a2e:370:7334", doc);
2208         check!("102:304:506:708:90a:b0c:d0e:f10", global);
2209     }
2210
2211     #[test]
2212     fn ipv4_properties() {
2213         macro_rules! ip {
2214             ($s:expr) => {
2215                 Ipv4Addr::from_str($s).unwrap()
2216             };
2217         }
2218
2219         macro_rules! check {
2220             ($s:expr) => {
2221                 check!($s, 0);
2222             };
2223
2224             ($s:expr, $mask:expr) => {{
2225                 let unspec: u16 = 1 << 0;
2226                 let loopback: u16 = 1 << 1;
2227                 let private: u16 = 1 << 2;
2228                 let link_local: u16 = 1 << 3;
2229                 let global: u16 = 1 << 4;
2230                 let multicast: u16 = 1 << 5;
2231                 let broadcast: u16 = 1 << 6;
2232                 let documentation: u16 = 1 << 7;
2233                 let benchmarking: u16 = 1 << 8;
2234                 let ietf_protocol_assignment: u16 = 1 << 9;
2235                 let reserved: u16 = 1 << 10;
2236                 let shared: u16 = 1 << 11;
2237
2238                 if ($mask & unspec) == unspec {
2239                     assert!(ip!($s).is_unspecified());
2240                 } else {
2241                     assert!(!ip!($s).is_unspecified());
2242                 }
2243
2244                 if ($mask & loopback) == loopback {
2245                     assert!(ip!($s).is_loopback());
2246                 } else {
2247                     assert!(!ip!($s).is_loopback());
2248                 }
2249
2250                 if ($mask & private) == private {
2251                     assert!(ip!($s).is_private());
2252                 } else {
2253                     assert!(!ip!($s).is_private());
2254                 }
2255
2256                 if ($mask & link_local) == link_local {
2257                     assert!(ip!($s).is_link_local());
2258                 } else {
2259                     assert!(!ip!($s).is_link_local());
2260                 }
2261
2262                 if ($mask & global) == global {
2263                     assert!(ip!($s).is_global());
2264                 } else {
2265                     assert!(!ip!($s).is_global());
2266                 }
2267
2268                 if ($mask & multicast) == multicast {
2269                     assert!(ip!($s).is_multicast());
2270                 } else {
2271                     assert!(!ip!($s).is_multicast());
2272                 }
2273
2274                 if ($mask & broadcast) == broadcast {
2275                     assert!(ip!($s).is_broadcast());
2276                 } else {
2277                     assert!(!ip!($s).is_broadcast());
2278                 }
2279
2280                 if ($mask & documentation) == documentation {
2281                     assert!(ip!($s).is_documentation());
2282                 } else {
2283                     assert!(!ip!($s).is_documentation());
2284                 }
2285
2286                 if ($mask & benchmarking) == benchmarking {
2287                     assert!(ip!($s).is_benchmarking());
2288                 } else {
2289                     assert!(!ip!($s).is_benchmarking());
2290                 }
2291
2292                 if ($mask & ietf_protocol_assignment) == ietf_protocol_assignment {
2293                     assert!(ip!($s).is_ietf_protocol_assignment());
2294                 } else {
2295                     assert!(!ip!($s).is_ietf_protocol_assignment());
2296                 }
2297
2298                 if ($mask & reserved) == reserved {
2299                     assert!(ip!($s).is_reserved());
2300                 } else {
2301                     assert!(!ip!($s).is_reserved());
2302                 }
2303
2304                 if ($mask & shared) == shared {
2305                     assert!(ip!($s).is_shared());
2306                 } else {
2307                     assert!(!ip!($s).is_shared());
2308                 }
2309             }};
2310         }
2311
2312         let unspec: u16 = 1 << 0;
2313         let loopback: u16 = 1 << 1;
2314         let private: u16 = 1 << 2;
2315         let link_local: u16 = 1 << 3;
2316         let global: u16 = 1 << 4;
2317         let multicast: u16 = 1 << 5;
2318         let broadcast: u16 = 1 << 6;
2319         let documentation: u16 = 1 << 7;
2320         let benchmarking: u16 = 1 << 8;
2321         let ietf_protocol_assignment: u16 = 1 << 9;
2322         let reserved: u16 = 1 << 10;
2323         let shared: u16 = 1 << 11;
2324
2325         check!("0.0.0.0", unspec);
2326         check!("0.0.0.1");
2327         check!("0.1.0.0");
2328         check!("10.9.8.7", private);
2329         check!("127.1.2.3", loopback);
2330         check!("172.31.254.253", private);
2331         check!("169.254.253.242", link_local);
2332         check!("192.0.2.183", documentation);
2333         check!("192.1.2.183", global);
2334         check!("192.168.254.253", private);
2335         check!("198.51.100.0", documentation);
2336         check!("203.0.113.0", documentation);
2337         check!("203.2.113.0", global);
2338         check!("224.0.0.0", global | multicast);
2339         check!("239.255.255.255", global | multicast);
2340         check!("255.255.255.255", broadcast);
2341         check!("198.18.0.0", benchmarking);
2342         check!("198.18.54.2", benchmarking);
2343         check!("198.19.255.255", benchmarking);
2344         check!("192.0.0.0", ietf_protocol_assignment);
2345         check!("192.0.0.255", ietf_protocol_assignment);
2346         check!("192.0.0.100", ietf_protocol_assignment);
2347         check!("240.0.0.0", reserved);
2348         check!("251.54.1.76", reserved);
2349         check!("254.255.255.255", reserved);
2350         check!("100.64.0.0", shared);
2351         check!("100.127.255.255", shared);
2352         check!("100.100.100.0", shared);
2353     }
2354
2355     #[test]
2356     fn ipv6_properties() {
2357         macro_rules! ip {
2358             ($s:expr) => {
2359                 Ipv6Addr::from_str($s).unwrap()
2360             };
2361         }
2362
2363         macro_rules! check {
2364             ($s:expr, &[$($octet:expr),*], $mask:expr) => {
2365                 assert_eq!($s, ip!($s).to_string());
2366                 let octets = &[$($octet),*];
2367                 assert_eq!(&ip!($s).octets(), octets);
2368                 assert_eq!(Ipv6Addr::from(*octets), ip!($s));
2369
2370                 let unspecified: u16 = 1 << 0;
2371                 let loopback: u16 = 1 << 1;
2372                 let unique_local: u16 = 1 << 2;
2373                 let global: u16 = 1 << 3;
2374                 let unicast_link_local: u16 = 1 << 4;
2375                 let unicast_link_local_strict: u16 = 1 << 5;
2376                 let unicast_site_local: u16 = 1 << 6;
2377                 let unicast_global: u16 = 1 << 7;
2378                 let documentation: u16 = 1 << 8;
2379                 let multicast_interface_local: u16 = 1 << 9;
2380                 let multicast_link_local: u16 = 1 << 10;
2381                 let multicast_realm_local: u16 = 1 << 11;
2382                 let multicast_admin_local: u16 = 1 << 12;
2383                 let multicast_site_local: u16 = 1 << 13;
2384                 let multicast_organization_local: u16 = 1 << 14;
2385                 let multicast_global: u16 = 1 << 15;
2386                 let multicast: u16 = multicast_interface_local
2387                     | multicast_admin_local
2388                     | multicast_global
2389                     | multicast_link_local
2390                     | multicast_realm_local
2391                     | multicast_site_local
2392                     | multicast_organization_local;
2393
2394                 if ($mask & unspecified) == unspecified {
2395                     assert!(ip!($s).is_unspecified());
2396                 } else {
2397                     assert!(!ip!($s).is_unspecified());
2398                 }
2399                 if ($mask & loopback) == loopback {
2400                     assert!(ip!($s).is_loopback());
2401                 } else {
2402                     assert!(!ip!($s).is_loopback());
2403                 }
2404                 if ($mask & unique_local) == unique_local {
2405                     assert!(ip!($s).is_unique_local());
2406                 } else {
2407                     assert!(!ip!($s).is_unique_local());
2408                 }
2409                 if ($mask & global) == global {
2410                     assert!(ip!($s).is_global());
2411                 } else {
2412                     assert!(!ip!($s).is_global());
2413                 }
2414                 if ($mask & unicast_link_local) == unicast_link_local {
2415                     assert!(ip!($s).is_unicast_link_local());
2416                 } else {
2417                     assert!(!ip!($s).is_unicast_link_local());
2418                 }
2419                 if ($mask & unicast_link_local_strict) == unicast_link_local_strict {
2420                     assert!(ip!($s).is_unicast_link_local_strict());
2421                 } else {
2422                     assert!(!ip!($s).is_unicast_link_local_strict());
2423                 }
2424                 if ($mask & unicast_site_local) == unicast_site_local {
2425                     assert!(ip!($s).is_unicast_site_local());
2426                 } else {
2427                     assert!(!ip!($s).is_unicast_site_local());
2428                 }
2429                 if ($mask & unicast_global) == unicast_global {
2430                     assert!(ip!($s).is_unicast_global());
2431                 } else {
2432                     assert!(!ip!($s).is_unicast_global());
2433                 }
2434                 if ($mask & documentation) == documentation {
2435                     assert!(ip!($s).is_documentation());
2436                 } else {
2437                     assert!(!ip!($s).is_documentation());
2438                 }
2439                 if ($mask & multicast) != 0 {
2440                     assert!(ip!($s).multicast_scope().is_some());
2441                     assert!(ip!($s).is_multicast());
2442                 } else {
2443                     assert!(ip!($s).multicast_scope().is_none());
2444                     assert!(!ip!($s).is_multicast());
2445                 }
2446                 if ($mask & multicast_interface_local) == multicast_interface_local {
2447                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2448                                Ipv6MulticastScope::InterfaceLocal);
2449                 }
2450                 if ($mask & multicast_link_local) == multicast_link_local {
2451                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2452                                Ipv6MulticastScope::LinkLocal);
2453                 }
2454                 if ($mask & multicast_realm_local) == multicast_realm_local {
2455                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2456                                Ipv6MulticastScope::RealmLocal);
2457                 }
2458                 if ($mask & multicast_admin_local) == multicast_admin_local {
2459                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2460                                Ipv6MulticastScope::AdminLocal);
2461                 }
2462                 if ($mask & multicast_site_local) == multicast_site_local {
2463                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2464                                Ipv6MulticastScope::SiteLocal);
2465                 }
2466                 if ($mask & multicast_organization_local) == multicast_organization_local {
2467                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2468                                Ipv6MulticastScope::OrganizationLocal);
2469                 }
2470                 if ($mask & multicast_global) == multicast_global {
2471                     assert_eq!(ip!($s).multicast_scope().unwrap(),
2472                                Ipv6MulticastScope::Global);
2473                 }
2474             }
2475         }
2476
2477         let unspecified: u16 = 1 << 0;
2478         let loopback: u16 = 1 << 1;
2479         let unique_local: u16 = 1 << 2;
2480         let global: u16 = 1 << 3;
2481         let unicast_link_local: u16 = 1 << 4;
2482         let unicast_link_local_strict: u16 = 1 << 5;
2483         let unicast_site_local: u16 = 1 << 6;
2484         let unicast_global: u16 = 1 << 7;
2485         let documentation: u16 = 1 << 8;
2486         let multicast_interface_local: u16 = 1 << 9;
2487         let multicast_link_local: u16 = 1 << 10;
2488         let multicast_realm_local: u16 = 1 << 11;
2489         let multicast_admin_local: u16 = 1 << 12;
2490         let multicast_site_local: u16 = 1 << 13;
2491         let multicast_organization_local: u16 = 1 << 14;
2492         let multicast_global: u16 = 1 << 15;
2493
2494         check!("::", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unspecified);
2495
2496         check!("::1", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1], loopback);
2497
2498         check!(
2499             "::0.0.0.2",
2500             &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2],
2501             global | unicast_global
2502         );
2503
2504         check!("1::", &[0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], global | unicast_global);
2505
2506         check!("fc00::", &[0xfc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unique_local);
2507
2508         check!(
2509             "fdff:ffff::",
2510             &[0xfd, 0xff, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2511             unique_local
2512         );
2513
2514         check!(
2515             "fe80:ffff::",
2516             &[0xfe, 0x80, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2517             unicast_link_local
2518         );
2519
2520         check!(
2521             "fe80::",
2522             &[0xfe, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2523             unicast_link_local | unicast_link_local_strict
2524         );
2525
2526         check!(
2527             "febf:ffff::",
2528             &[0xfe, 0xbf, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2529             unicast_link_local
2530         );
2531
2532         check!(
2533             "febf::",
2534             &[0xfe, 0xbf, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2535             unicast_link_local
2536         );
2537
2538         check!(
2539             "febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
2540             &[
2541                 0xfe, 0xbf, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2542                 0xff, 0xff
2543             ],
2544             unicast_link_local
2545         );
2546
2547         check!(
2548             "fe80::ffff:ffff:ffff:ffff",
2549             &[
2550                 0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2551                 0xff, 0xff
2552             ],
2553             unicast_link_local | unicast_link_local_strict
2554         );
2555
2556         check!(
2557             "fe80:0:0:1::",
2558             &[0xfe, 0x80, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
2559             unicast_link_local
2560         );
2561
2562         check!(
2563             "fec0::",
2564             &[0xfe, 0xc0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2565             unicast_site_local | unicast_global | global
2566         );
2567
2568         check!(
2569             "ff01::",
2570             &[0xff, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2571             multicast_interface_local
2572         );
2573
2574         check!(
2575             "ff02::",
2576             &[0xff, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2577             multicast_link_local
2578         );
2579
2580         check!(
2581             "ff03::",
2582             &[0xff, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2583             multicast_realm_local
2584         );
2585
2586         check!(
2587             "ff04::",
2588             &[0xff, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2589             multicast_admin_local
2590         );
2591
2592         check!(
2593             "ff05::",
2594             &[0xff, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2595             multicast_site_local
2596         );
2597
2598         check!(
2599             "ff08::",
2600             &[0xff, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2601             multicast_organization_local
2602         );
2603
2604         check!(
2605             "ff0e::",
2606             &[0xff, 0xe, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2607             multicast_global | global
2608         );
2609
2610         check!(
2611             "2001:db8:85a3::8a2e:370:7334",
2612             &[0x20, 1, 0xd, 0xb8, 0x85, 0xa3, 0, 0, 0, 0, 0x8a, 0x2e, 3, 0x70, 0x73, 0x34],
2613             documentation
2614         );
2615
2616         check!(
2617             "102:304:506:708:90a:b0c:d0e:f10",
2618             &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16],
2619             global | unicast_global
2620         );
2621     }
2622
2623     #[test]
2624     fn to_socket_addr_socketaddr() {
2625         let a = sa4(Ipv4Addr::new(77, 88, 21, 11), 12345);
2626         assert_eq!(Ok(vec![a]), tsa(a));
2627     }
2628
2629     #[test]
2630     fn test_ipv4_to_int() {
2631         let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2632         assert_eq!(u32::from(a), 0x11223344);
2633     }
2634
2635     #[test]
2636     fn test_int_to_ipv4() {
2637         let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2638         assert_eq!(Ipv4Addr::from(0x11223344), a);
2639     }
2640
2641     #[test]
2642     fn test_ipv6_to_int() {
2643         let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2644         assert_eq!(u128::from(a), 0x112233445566778899aabbccddeeff11u128);
2645     }
2646
2647     #[test]
2648     fn test_int_to_ipv6() {
2649         let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2650         assert_eq!(Ipv6Addr::from(0x112233445566778899aabbccddeeff11u128), a);
2651     }
2652
2653     #[test]
2654     fn ipv4_from_constructors() {
2655         assert_eq!(Ipv4Addr::LOCALHOST, Ipv4Addr::new(127, 0, 0, 1));
2656         assert!(Ipv4Addr::LOCALHOST.is_loopback());
2657         assert_eq!(Ipv4Addr::UNSPECIFIED, Ipv4Addr::new(0, 0, 0, 0));
2658         assert!(Ipv4Addr::UNSPECIFIED.is_unspecified());
2659         assert_eq!(Ipv4Addr::BROADCAST, Ipv4Addr::new(255, 255, 255, 255));
2660         assert!(Ipv4Addr::BROADCAST.is_broadcast());
2661     }
2662
2663     #[test]
2664     fn ipv6_from_contructors() {
2665         assert_eq!(Ipv6Addr::LOCALHOST, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
2666         assert!(Ipv6Addr::LOCALHOST.is_loopback());
2667         assert_eq!(Ipv6Addr::UNSPECIFIED, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
2668         assert!(Ipv6Addr::UNSPECIFIED.is_unspecified());
2669     }
2670
2671     #[test]
2672     fn ipv4_from_octets() {
2673         assert_eq!(Ipv4Addr::from([127, 0, 0, 1]), Ipv4Addr::new(127, 0, 0, 1))
2674     }
2675
2676     #[test]
2677     fn ipv6_from_segments() {
2678         let from_u16s =
2679             Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2680         let new = Ipv6Addr::new(0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff);
2681         assert_eq!(new, from_u16s);
2682     }
2683
2684     #[test]
2685     fn ipv6_from_octets() {
2686         let from_u16s =
2687             Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2688         let from_u8s = Ipv6Addr::from([
2689             0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd,
2690             0xee, 0xff,
2691         ]);
2692         assert_eq!(from_u16s, from_u8s);
2693     }
2694
2695     #[test]
2696     fn cmp() {
2697         let v41 = Ipv4Addr::new(100, 64, 3, 3);
2698         let v42 = Ipv4Addr::new(192, 0, 2, 2);
2699         let v61 = "2001:db8:f00::1002".parse::<Ipv6Addr>().unwrap();
2700         let v62 = "2001:db8:f00::2001".parse::<Ipv6Addr>().unwrap();
2701         assert!(v41 < v42);
2702         assert!(v61 < v62);
2703
2704         assert_eq!(v41, IpAddr::V4(v41));
2705         assert_eq!(v61, IpAddr::V6(v61));
2706         assert!(v41 != IpAddr::V4(v42));
2707         assert!(v61 != IpAddr::V6(v62));
2708
2709         assert!(v41 < IpAddr::V4(v42));
2710         assert!(v61 < IpAddr::V6(v62));
2711         assert!(IpAddr::V4(v41) < v42);
2712         assert!(IpAddr::V6(v61) < v62);
2713
2714         assert!(v41 < IpAddr::V6(v61));
2715         assert!(IpAddr::V4(v41) < v61);
2716     }
2717
2718     #[test]
2719     fn is_v4() {
2720         let ip = IpAddr::V4(Ipv4Addr::new(100, 64, 3, 3));
2721         assert!(ip.is_ipv4());
2722         assert!(!ip.is_ipv6());
2723     }
2724
2725     #[test]
2726     fn is_v6() {
2727         let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678));
2728         assert!(!ip.is_ipv4());
2729         assert!(ip.is_ipv6());
2730     }
2731 }