3 reason = "extra functionality has not been \
4 scrutinized to the level that it should \
9 use crate::cmp::Ordering;
13 use crate::sys::net::netc as c;
14 use crate::sys_common::{AsInner, FromInner};
16 /// An IP address, either IPv4 or IPv6.
18 /// This enum can contain either an [`Ipv4Addr`] or an [`Ipv6Addr`], see their
19 /// respective documentation for more details.
21 /// The size of an `IpAddr` instance may vary depending on the target operating
24 /// [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
25 /// [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
30 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
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));
35 /// assert_eq!("127.0.0.1".parse(), Ok(localhost_v4));
36 /// assert_eq!("::1".parse(), Ok(localhost_v6));
38 /// assert_eq!(localhost_v4.is_ipv6(), false);
39 /// assert_eq!(localhost_v4.is_ipv4(), true);
41 #[stable(feature = "ip_addr", since = "1.7.0")]
42 #[derive(Copy, Clone, Eq, PartialEq, Debug, Hash, PartialOrd, Ord)]
45 #[stable(feature = "ip_addr", since = "1.7.0")]
46 V4(#[stable(feature = "ip_addr", since = "1.7.0")] Ipv4Addr),
48 #[stable(feature = "ip_addr", since = "1.7.0")]
49 V6(#[stable(feature = "ip_addr", since = "1.7.0")] Ipv6Addr),
54 /// IPv4 addresses are defined as 32-bit integers in [IETF RFC 791].
55 /// They are usually represented as four octets.
57 /// See [`IpAddr`] for a type encompassing both IPv4 and IPv6 addresses.
59 /// The size of an `Ipv4Addr` struct may vary depending on the target operating
62 /// [IETF RFC 791]: https://tools.ietf.org/html/rfc791
63 /// [`IpAddr`]: ../../std/net/enum.IpAddr.html
65 /// # Textual representation
67 /// `Ipv4Addr` provides a [`FromStr`] implementation. The four octets are in decimal
68 /// notation, divided by `.` (this is called "dot-decimal notation").
70 /// [`FromStr`]: ../../std/str/trait.FromStr.html
75 /// use std::net::Ipv4Addr;
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);
82 #[stable(feature = "rust1", since = "1.0.0")]
89 /// IPv6 addresses are defined as 128-bit integers in [IETF RFC 4291].
90 /// They are usually represented as eight 16-bit segments.
92 /// See [`IpAddr`] for a type encompassing both IPv4 and IPv6 addresses.
94 /// The size of an `Ipv6Addr` struct may vary depending on the target operating
97 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
98 /// [`IpAddr`]: ../../std/net/enum.IpAddr.html
100 /// # Textual representation
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
107 /// [`FromStr`]: ../../std/str/trait.FromStr.html
108 /// [IETF RFC 5952]: https://tools.ietf.org/html/rfc5952
113 /// use std::net::Ipv6Addr;
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);
120 #[stable(feature = "rust1", since = "1.0.0")]
121 pub struct Ipv6Addr {
125 #[allow(missing_docs)]
126 #[derive(Copy, PartialEq, Eq, Clone, Hash, Debug)]
127 pub enum Ipv6MulticastScope {
138 /// Returns [`true`] for the special 'unspecified' address.
140 /// See the documentation for [`Ipv4Addr::is_unspecified`][IPv4] and
141 /// [`Ipv6Addr::is_unspecified`][IPv6] for more details.
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
150 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
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);
155 #[stable(feature = "ip_shared", since = "1.12.0")]
156 pub fn is_unspecified(&self) -> bool {
158 IpAddr::V4(ip) => ip.is_unspecified(),
159 IpAddr::V6(ip) => ip.is_unspecified(),
163 /// Returns [`true`] if this is a loopback address.
165 /// See the documentation for [`Ipv4Addr::is_loopback`][IPv4] and
166 /// [`Ipv6Addr::is_loopback`][IPv6] for more details.
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
175 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
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);
180 #[stable(feature = "ip_shared", since = "1.12.0")]
181 pub fn is_loopback(&self) -> bool {
183 IpAddr::V4(ip) => ip.is_loopback(),
184 IpAddr::V6(ip) => ip.is_loopback(),
188 /// Returns [`true`] if the address appears to be globally routable.
190 /// See the documentation for [`Ipv4Addr::is_global`][IPv4] and
191 /// [`Ipv6Addr::is_global`][IPv6] for more details.
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
202 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
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);
207 pub fn is_global(&self) -> bool {
209 IpAddr::V4(ip) => ip.is_global(),
210 IpAddr::V6(ip) => ip.is_global(),
214 /// Returns [`true`] if this is a multicast address.
216 /// See the documentation for [`Ipv4Addr::is_multicast`][IPv4] and
217 /// [`Ipv6Addr::is_multicast`][IPv6] for more details.
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
226 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
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);
231 #[stable(feature = "ip_shared", since = "1.12.0")]
232 pub fn is_multicast(&self) -> bool {
234 IpAddr::V4(ip) => ip.is_multicast(),
235 IpAddr::V6(ip) => ip.is_multicast(),
239 /// Returns [`true`] if this address is in a range designated for documentation.
241 /// See the documentation for [`Ipv4Addr::is_documentation`][IPv4] and
242 /// [`Ipv6Addr::is_documentation`][IPv6] for more details.
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
253 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
255 /// assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_documentation(), true);
257 /// IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_documentation(),
261 pub fn is_documentation(&self) -> bool {
263 IpAddr::V4(ip) => ip.is_documentation(),
264 IpAddr::V6(ip) => ip.is_documentation(),
268 /// Returns [`true`] if this address is an [IPv4 address], and [`false`] otherwise.
270 /// [`true`]: ../../std/primitive.bool.html
271 /// [`false`]: ../../std/primitive.bool.html
272 /// [IPv4 address]: #variant.V4
277 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
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);
282 #[stable(feature = "ipaddr_checker", since = "1.16.0")]
283 pub fn is_ipv4(&self) -> bool {
284 matches!(self, IpAddr::V4(_))
287 /// Returns [`true`] if this address is an [IPv6 address], and [`false`] otherwise.
289 /// [`true`]: ../../std/primitive.bool.html
290 /// [`false`]: ../../std/primitive.bool.html
291 /// [IPv6 address]: #variant.V6
296 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
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);
301 #[stable(feature = "ipaddr_checker", since = "1.16.0")]
302 pub fn is_ipv6(&self) -> bool {
303 matches!(self, IpAddr::V6(_))
308 /// Creates a new IPv4 address from four eight-bit octets.
310 /// The result will represent the IP address `a`.`b`.`c`.`d`.
315 /// use std::net::Ipv4Addr;
317 /// let addr = Ipv4Addr::new(127, 0, 0, 1);
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
327 ((a as u32) << 24) | ((b as u32) << 16) | ((c as u32) << 8) | (d as u32),
333 /// An IPv4 address with the address pointing to localhost: 127.0.0.1.
338 /// use std::net::Ipv4Addr;
340 /// let addr = Ipv4Addr::LOCALHOST;
341 /// assert_eq!(addr, Ipv4Addr::new(127, 0, 0, 1));
343 #[stable(feature = "ip_constructors", since = "1.30.0")]
344 pub const LOCALHOST: Self = Ipv4Addr::new(127, 0, 0, 1);
346 /// An IPv4 address representing an unspecified address: 0.0.0.0
351 /// use std::net::Ipv4Addr;
353 /// let addr = Ipv4Addr::UNSPECIFIED;
354 /// assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));
356 #[stable(feature = "ip_constructors", since = "1.30.0")]
357 pub const UNSPECIFIED: Self = Ipv4Addr::new(0, 0, 0, 0);
359 /// An IPv4 address representing the broadcast address: 255.255.255.255
364 /// use std::net::Ipv4Addr;
366 /// let addr = Ipv4Addr::BROADCAST;
367 /// assert_eq!(addr, Ipv4Addr::new(255, 255, 255, 255));
369 #[stable(feature = "ip_constructors", since = "1.30.0")]
370 pub const BROADCAST: Self = Ipv4Addr::new(255, 255, 255, 255);
372 /// Returns the four eight-bit integers that make up this address.
377 /// use std::net::Ipv4Addr;
379 /// let addr = Ipv4Addr::new(127, 0, 0, 1);
380 /// assert_eq!(addr.octets(), [127, 0, 0, 1]);
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()
388 /// Returns [`true`] for the special 'unspecified' address (0.0.0.0).
390 /// This property is defined in _UNIX Network Programming, Second Edition_,
391 /// W. Richard Stevens, p. 891; see also [ip7].
393 /// [ip7]: http://man7.org/linux/man-pages/man7/ip.7.html
394 /// [`true`]: ../../std/primitive.bool.html
399 /// use std::net::Ipv4Addr;
401 /// assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_unspecified(), true);
402 /// assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_unspecified(), false);
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
410 /// Returns [`true`] if this is a loopback address (127.0.0.0/8).
412 /// This property is defined by [IETF RFC 1122].
414 /// [IETF RFC 1122]: https://tools.ietf.org/html/rfc1122
415 /// [`true`]: ../../std/primitive.bool.html
420 /// use std::net::Ipv4Addr;
422 /// assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_loopback(), true);
423 /// assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_loopback(), false);
425 #[stable(since = "1.7.0", feature = "ip_17")]
426 pub fn is_loopback(&self) -> bool {
427 self.octets()[0] == 127
430 /// Returns [`true`] if this is a private address.
432 /// The private address ranges are defined in [IETF RFC 1918] and include:
438 /// [IETF RFC 1918]: https://tools.ietf.org/html/rfc1918
439 /// [`true`]: ../../std/primitive.bool.html
444 /// use std::net::Ipv4Addr;
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);
454 #[stable(since = "1.7.0", feature = "ip_17")]
455 pub fn is_private(&self) -> bool {
456 match self.octets() {
458 [172, b, ..] if b >= 16 && b <= 31 => true,
459 [192, 168, ..] => true,
464 /// Returns [`true`] if the address is link-local (169.254.0.0/16).
466 /// This property is defined by [IETF RFC 3927].
468 /// [IETF RFC 3927]: https://tools.ietf.org/html/rfc3927
469 /// [`true`]: ../../std/primitive.bool.html
474 /// use std::net::Ipv4Addr;
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);
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,
488 /// Returns [`true`] if the address appears to be globally routable.
489 /// See [iana-ipv4-special-registry][ipv4-sr].
491 /// The following return false:
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
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))
507 /// [ipv4-sr]: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
508 /// [`true`]: ../../std/primitive.bool.html
515 /// use std::net::Ipv4Addr;
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);
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);
527 /// // the loopback address is not global
528 /// assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_global(), false);
530 /// // link local addresses are not global
531 /// assert_eq!(Ipv4Addr::new(169, 254, 45, 1).is_global(), false);
533 /// // the broadcast address is not global
534 /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_global(), false);
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);
541 /// // shared addresses are not global
542 /// assert_eq!(Ipv4Addr::new(100, 100, 0, 0).is_global(), false);
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);
548 /// // addresses reserved for future use are not global
549 /// assert_eq!(Ipv4Addr::new(250, 10, 20, 30).is_global(), false);
551 /// // addresses reserved for network devices benchmarking are not global
552 /// assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_global(), false);
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);
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 {
565 && !self.is_loopback()
566 && !self.is_link_local()
567 && !self.is_broadcast()
568 && !self.is_documentation()
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
577 /// Returns [`true`] if this address is part of the Shared Address Space defined in
578 /// [IETF RFC 6598] (`100.64.0.0/10`).
580 /// [IETF RFC 6598]: https://tools.ietf.org/html/rfc6598
581 /// [`true`]: ../../std/primitive.bool.html
587 /// use std::net::Ipv4Addr;
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);
593 pub fn is_shared(&self) -> bool {
594 self.octets()[0] == 100 && (self.octets()[1] & 0b1100_0000 == 0b0100_0000)
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].
600 /// Note that parts of this block are in use:
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])
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
616 /// use std::net::Ipv4Addr;
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);
625 pub fn is_ietf_protocol_assignment(&self) -> bool {
626 self.octets()[0] == 192 && self.octets()[1] == 0 && self.octets()[2] == 0
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`.
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
641 /// use std::net::Ipv4Addr;
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);
648 pub fn is_benchmarking(&self) -> bool {
649 self.octets()[0] == 198 && (self.octets()[1] & 0xfe) == 18
652 /// Returns [`true`] if this address is reserved by IANA for future use. [IETF RFC 1112]
653 /// defines the block of reserved addresses as `240.0.0.0/4`. This range normally includes the
654 /// broadcast address `255.255.255.255`, but this implementation explicitely excludes it, since
655 /// it is obviously not reserved for future use.
657 /// [IETF RFC 1112]: https://tools.ietf.org/html/rfc1112
658 /// [`true`]: ../../std/primitive.bool.html
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
671 /// use std::net::Ipv4Addr;
673 /// assert_eq!(Ipv4Addr::new(240, 0, 0, 0).is_reserved(), true);
674 /// assert_eq!(Ipv4Addr::new(255, 255, 255, 254).is_reserved(), true);
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);
680 pub fn is_reserved(&self) -> bool {
681 self.octets()[0] & 240 == 240 && !self.is_broadcast()
684 /// Returns [`true`] if this is a multicast address (224.0.0.0/4).
686 /// Multicast addresses have a most significant octet between 224 and 239,
687 /// and is defined by [IETF RFC 5771].
689 /// [IETF RFC 5771]: https://tools.ietf.org/html/rfc5771
690 /// [`true`]: ../../std/primitive.bool.html
695 /// use std::net::Ipv4Addr;
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);
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
706 /// Returns [`true`] if this is a broadcast address (255.255.255.255).
708 /// A broadcast address has all octets set to 255 as defined in [IETF RFC 919].
710 /// [IETF RFC 919]: https://tools.ietf.org/html/rfc919
711 /// [`true`]: ../../std/primitive.bool.html
716 /// use std::net::Ipv4Addr;
718 /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_broadcast(), true);
719 /// assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_broadcast(), false);
721 #[stable(since = "1.7.0", feature = "ip_17")]
722 pub fn is_broadcast(&self) -> bool {
723 self == &Self::BROADCAST
726 /// Returns [`true`] if this address is in a range designated for documentation.
728 /// This is defined in [IETF RFC 5737]:
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)
734 /// [IETF RFC 5737]: https://tools.ietf.org/html/rfc5737
735 /// [`true`]: ../../std/primitive.bool.html
740 /// use std::net::Ipv4Addr;
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);
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,
757 /// Converts this address to an IPv4-compatible [IPv6 address].
759 /// a.b.c.d becomes ::a.b.c.d
761 /// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
766 /// use std::net::{Ipv4Addr, Ipv6Addr};
769 /// Ipv4Addr::new(192, 0, 2, 255).to_ipv6_compatible(),
770 /// Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 767)
773 #[stable(feature = "rust1", since = "1.0.0")]
774 pub fn to_ipv6_compatible(&self) -> Ipv6Addr {
775 let octets = self.octets();
777 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, octets[0], octets[1], octets[2], octets[3],
781 /// Converts this address to an IPv4-mapped [IPv6 address].
783 /// a.b.c.d becomes ::ffff:a.b.c.d
785 /// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
790 /// use std::net::{Ipv4Addr, Ipv6Addr};
792 /// assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_mapped(),
793 /// Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 49152, 767));
795 #[stable(feature = "rust1", since = "1.0.0")]
796 pub fn to_ipv6_mapped(&self) -> Ipv6Addr {
797 let octets = self.octets();
799 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF, octets[0], octets[1], octets[2], octets[3],
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 {
808 IpAddr::V4(ip) => ip.fmt(fmt),
809 IpAddr::V6(ip) => ip.fmt(fmt),
814 #[stable(feature = "ip_from_ip", since = "1.16.0")]
815 impl From<Ipv4Addr> for IpAddr {
816 fn from(ipv4: Ipv4Addr) -> IpAddr {
821 #[stable(feature = "ip_from_ip", since = "1.16.0")]
822 impl From<Ipv6Addr> for IpAddr {
823 fn from(ipv6: Ipv6Addr) -> IpAddr {
828 #[stable(feature = "rust1", since = "1.0.0")]
829 impl fmt::Display for Ipv4Addr {
830 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
831 const IPV4_BUF_LEN: usize = 15; // Long enough for the longest possible IPv4 address
832 let mut buf = [0u8; IPV4_BUF_LEN];
833 let mut buf_slice = &mut buf[..];
834 let octets = self.octets();
835 // Note: The call to write should never fail, hence the unwrap
836 write!(buf_slice, "{}.{}.{}.{}", octets[0], octets[1], octets[2], octets[3]).unwrap();
837 let len = IPV4_BUF_LEN - buf_slice.len();
838 // This unsafe is OK because we know what is being written to the buffer
839 let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
844 #[stable(feature = "rust1", since = "1.0.0")]
845 impl fmt::Debug for Ipv4Addr {
846 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
847 fmt::Display::fmt(self, fmt)
851 #[stable(feature = "rust1", since = "1.0.0")]
852 impl Clone for Ipv4Addr {
853 fn clone(&self) -> Ipv4Addr {
858 #[stable(feature = "rust1", since = "1.0.0")]
859 impl PartialEq for Ipv4Addr {
860 fn eq(&self, other: &Ipv4Addr) -> bool {
861 self.inner.s_addr == other.inner.s_addr
865 #[stable(feature = "ip_cmp", since = "1.16.0")]
866 impl PartialEq<Ipv4Addr> for IpAddr {
867 fn eq(&self, other: &Ipv4Addr) -> bool {
869 IpAddr::V4(v4) => v4 == other,
870 IpAddr::V6(_) => false,
875 #[stable(feature = "ip_cmp", since = "1.16.0")]
876 impl PartialEq<IpAddr> for Ipv4Addr {
877 fn eq(&self, other: &IpAddr) -> bool {
879 IpAddr::V4(v4) => self == v4,
880 IpAddr::V6(_) => false,
885 #[stable(feature = "rust1", since = "1.0.0")]
886 impl Eq for Ipv4Addr {}
888 #[stable(feature = "rust1", since = "1.0.0")]
889 impl hash::Hash for Ipv4Addr {
890 fn hash<H: hash::Hasher>(&self, s: &mut H) {
891 // `inner` is #[repr(packed)], so we need to copy `s_addr`.
892 { self.inner.s_addr }.hash(s)
896 #[stable(feature = "rust1", since = "1.0.0")]
897 impl PartialOrd for Ipv4Addr {
898 fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
899 Some(self.cmp(other))
903 #[stable(feature = "ip_cmp", since = "1.16.0")]
904 impl PartialOrd<Ipv4Addr> for IpAddr {
905 fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
907 IpAddr::V4(v4) => v4.partial_cmp(other),
908 IpAddr::V6(_) => Some(Ordering::Greater),
913 #[stable(feature = "ip_cmp", since = "1.16.0")]
914 impl PartialOrd<IpAddr> for Ipv4Addr {
915 fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
917 IpAddr::V4(v4) => self.partial_cmp(v4),
918 IpAddr::V6(_) => Some(Ordering::Less),
923 #[stable(feature = "rust1", since = "1.0.0")]
924 impl Ord for Ipv4Addr {
925 fn cmp(&self, other: &Ipv4Addr) -> Ordering {
926 u32::from_be(self.inner.s_addr).cmp(&u32::from_be(other.inner.s_addr))
930 impl AsInner<c::in_addr> for Ipv4Addr {
931 fn as_inner(&self) -> &c::in_addr {
935 impl FromInner<c::in_addr> for Ipv4Addr {
936 fn from_inner(addr: c::in_addr) -> Ipv4Addr {
937 Ipv4Addr { inner: addr }
941 #[stable(feature = "ip_u32", since = "1.1.0")]
942 impl From<Ipv4Addr> for u32 {
943 /// Converts an `Ipv4Addr` into a host byte order `u32`.
948 /// use std::net::Ipv4Addr;
950 /// let addr = Ipv4Addr::new(13, 12, 11, 10);
951 /// assert_eq!(0x0d0c0b0au32, u32::from(addr));
953 fn from(ip: Ipv4Addr) -> u32 {
954 let ip = ip.octets();
955 u32::from_be_bytes(ip)
959 #[stable(feature = "ip_u32", since = "1.1.0")]
960 impl From<u32> for Ipv4Addr {
961 /// Converts a host byte order `u32` into an `Ipv4Addr`.
966 /// use std::net::Ipv4Addr;
968 /// let addr = Ipv4Addr::from(0x0d0c0b0au32);
969 /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
971 fn from(ip: u32) -> Ipv4Addr {
972 Ipv4Addr::from(ip.to_be_bytes())
976 #[stable(feature = "from_slice_v4", since = "1.9.0")]
977 impl From<[u8; 4]> for Ipv4Addr {
981 /// use std::net::Ipv4Addr;
983 /// let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]);
984 /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
986 fn from(octets: [u8; 4]) -> Ipv4Addr {
987 Ipv4Addr::new(octets[0], octets[1], octets[2], octets[3])
991 #[stable(feature = "ip_from_slice", since = "1.17.0")]
992 impl From<[u8; 4]> for IpAddr {
993 /// Creates an `IpAddr::V4` from a four element byte array.
998 /// use std::net::{IpAddr, Ipv4Addr};
1000 /// let addr = IpAddr::from([13u8, 12u8, 11u8, 10u8]);
1001 /// assert_eq!(IpAddr::V4(Ipv4Addr::new(13, 12, 11, 10)), addr);
1003 fn from(octets: [u8; 4]) -> IpAddr {
1004 IpAddr::V4(Ipv4Addr::from(octets))
1009 /// Creates a new IPv6 address from eight 16-bit segments.
1011 /// The result will represent the IP address `a:b:c:d:e:f:g:h`.
1016 /// use std::net::Ipv6Addr;
1018 /// let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);
1020 #[stable(feature = "rust1", since = "1.0.0")]
1021 #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1022 pub const fn new(a: u16, b: u16, c: u16, d: u16, e: u16, f: u16, g: u16, h: u16) -> Ipv6Addr {
1024 inner: c::in6_addr {
1047 /// An IPv6 address representing localhost: `::1`.
1052 /// use std::net::Ipv6Addr;
1054 /// let addr = Ipv6Addr::LOCALHOST;
1055 /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
1057 #[stable(feature = "ip_constructors", since = "1.30.0")]
1058 pub const LOCALHOST: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
1060 /// An IPv6 address representing the unspecified address: `::`
1065 /// use std::net::Ipv6Addr;
1067 /// let addr = Ipv6Addr::UNSPECIFIED;
1068 /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
1070 #[stable(feature = "ip_constructors", since = "1.30.0")]
1071 pub const UNSPECIFIED: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0);
1073 /// Returns the eight 16-bit segments that make up this address.
1078 /// use std::net::Ipv6Addr;
1080 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).segments(),
1081 /// [0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff]);
1083 #[stable(feature = "rust1", since = "1.0.0")]
1084 pub fn segments(&self) -> [u16; 8] {
1085 let arr = &self.inner.s6_addr;
1087 u16::from_be_bytes([arr[0], arr[1]]),
1088 u16::from_be_bytes([arr[2], arr[3]]),
1089 u16::from_be_bytes([arr[4], arr[5]]),
1090 u16::from_be_bytes([arr[6], arr[7]]),
1091 u16::from_be_bytes([arr[8], arr[9]]),
1092 u16::from_be_bytes([arr[10], arr[11]]),
1093 u16::from_be_bytes([arr[12], arr[13]]),
1094 u16::from_be_bytes([arr[14], arr[15]]),
1098 /// Returns [`true`] for the special 'unspecified' address (::).
1100 /// This property is defined in [IETF RFC 4291].
1102 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1103 /// [`true`]: ../../std/primitive.bool.html
1108 /// use std::net::Ipv6Addr;
1110 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false);
1111 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);
1113 #[stable(since = "1.7.0", feature = "ip_17")]
1114 pub fn is_unspecified(&self) -> bool {
1115 self.segments() == [0, 0, 0, 0, 0, 0, 0, 0]
1118 /// Returns [`true`] if this is a loopback address (::1).
1120 /// This property is defined in [IETF RFC 4291].
1122 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1123 /// [`true`]: ../../std/primitive.bool.html
1128 /// use std::net::Ipv6Addr;
1130 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false);
1131 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);
1133 #[stable(since = "1.7.0", feature = "ip_17")]
1134 pub fn is_loopback(&self) -> bool {
1135 self.segments() == [0, 0, 0, 0, 0, 0, 0, 1]
1138 /// Returns [`true`] if the address appears to be globally routable.
1140 /// The following return [`false`]:
1142 /// - the loopback address
1143 /// - link-local and unique local unicast addresses
1144 /// - interface-, link-, realm-, admin- and site-local multicast addresses
1146 /// [`true`]: ../../std/primitive.bool.html
1147 /// [`false`]: ../../std/primitive.bool.html
1154 /// use std::net::Ipv6Addr;
1156 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true);
1157 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false);
1158 /// assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true);
1160 pub fn is_global(&self) -> bool {
1161 match self.multicast_scope() {
1162 Some(Ipv6MulticastScope::Global) => true,
1163 None => self.is_unicast_global(),
1168 /// Returns [`true`] if this is a unique local address (`fc00::/7`).
1170 /// This property is defined in [IETF RFC 4193].
1172 /// [IETF RFC 4193]: https://tools.ietf.org/html/rfc4193
1173 /// [`true`]: ../../std/primitive.bool.html
1180 /// use std::net::Ipv6Addr;
1182 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false);
1183 /// assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true);
1185 pub fn is_unique_local(&self) -> bool {
1186 (self.segments()[0] & 0xfe00) == 0xfc00
1189 /// Returns [`true`] if the address is a unicast link-local address (`fe80::/64`).
1191 /// A common mis-conception is to think that "unicast link-local addresses start with
1192 /// `fe80::`", but the [IETF RFC 4291] actually defines a stricter format for these addresses:
1196 /// | bits | 54 bits | 64 bits |
1197 /// +----------+-------------------------+----------------------------+
1198 /// |1111111010| 0 | interface ID |
1199 /// +----------+-------------------------+----------------------------+
1202 /// This method validates the format defined in the RFC and won't recognize the following
1203 /// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
1204 /// If you need a less strict validation use [`is_unicast_link_local()`] instead.
1211 /// use std::net::Ipv6Addr;
1213 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1214 /// assert!(ip.is_unicast_link_local_strict());
1216 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1217 /// assert!(ip.is_unicast_link_local_strict());
1219 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1220 /// assert!(!ip.is_unicast_link_local_strict());
1221 /// assert!(ip.is_unicast_link_local());
1223 /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1224 /// assert!(!ip.is_unicast_link_local_strict());
1225 /// assert!(ip.is_unicast_link_local());
1230 /// - [IETF RFC 4291 section 2.5.6]
1231 /// - [RFC 4291 errata 4406]
1232 /// - [`is_unicast_link_local()`]
1234 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1235 /// [IETF RFC 4291 section 2.5.6]: https://tools.ietf.org/html/rfc4291#section-2.5.6
1236 /// [`true`]: ../../std/primitive.bool.html
1237 /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1238 /// [`is_unicast_link_local()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local
1240 pub fn is_unicast_link_local_strict(&self) -> bool {
1241 (self.segments()[0] & 0xffff) == 0xfe80
1242 && (self.segments()[1] & 0xffff) == 0
1243 && (self.segments()[2] & 0xffff) == 0
1244 && (self.segments()[3] & 0xffff) == 0
1247 /// Returns [`true`] if the address is a unicast link-local address (`fe80::/10`).
1249 /// This method returns [`true`] for addresses in the range reserved by [RFC 4291 section 2.4],
1250 /// i.e. addresses with the following format:
1254 /// | bits | 54 bits | 64 bits |
1255 /// +----------+-------------------------+----------------------------+
1256 /// |1111111010| arbitratry value | interface ID |
1257 /// +----------+-------------------------+----------------------------+
1260 /// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
1261 /// unicast link-local addresses, whereas [`is_unicast_link_local_strict()`] does not. If you
1262 /// need a strict validation fully compliant with the RFC, use
1263 /// [`is_unicast_link_local_strict()`].
1270 /// use std::net::Ipv6Addr;
1272 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1273 /// assert!(ip.is_unicast_link_local());
1275 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1276 /// assert!(ip.is_unicast_link_local());
1278 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1279 /// assert!(ip.is_unicast_link_local());
1280 /// assert!(!ip.is_unicast_link_local_strict());
1282 /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1283 /// assert!(ip.is_unicast_link_local());
1284 /// assert!(!ip.is_unicast_link_local_strict());
1289 /// - [IETF RFC 4291 section 2.4]
1290 /// - [RFC 4291 errata 4406]
1292 /// [IETF RFC 4291 section 2.4]: https://tools.ietf.org/html/rfc4291#section-2.4
1293 /// [`true`]: ../../std/primitive.bool.html
1294 /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1295 /// [`is_unicast_link_local_strict()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local_strict
1297 pub fn is_unicast_link_local(&self) -> bool {
1298 (self.segments()[0] & 0xffc0) == 0xfe80
1301 /// Returns [`true`] if this is a deprecated unicast site-local address (fec0::/10). The
1302 /// unicast site-local address format is defined in [RFC 4291 section 2.5.7] as:
1306 /// | bits | 54 bits | 64 bits |
1307 /// +----------+-------------------------+----------------------------+
1308 /// |1111111011| subnet ID | interface ID |
1309 /// +----------+-------------------------+----------------------------+
1312 /// [`true`]: ../../std/primitive.bool.html
1313 /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1320 /// use std::net::Ipv6Addr;
1323 /// Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_site_local(),
1326 /// assert_eq!(Ipv6Addr::new(0xfec2, 0, 0, 0, 0, 0, 0, 0).is_unicast_site_local(), true);
1331 /// As per [RFC 3879], the whole `FEC0::/10` prefix is
1332 /// deprecated. New software must not support site-local
1335 /// [RFC 3879]: https://tools.ietf.org/html/rfc3879
1336 pub fn is_unicast_site_local(&self) -> bool {
1337 (self.segments()[0] & 0xffc0) == 0xfec0
1340 /// Returns [`true`] if this is an address reserved for documentation
1341 /// (2001:db8::/32).
1343 /// This property is defined in [IETF RFC 3849].
1345 /// [IETF RFC 3849]: https://tools.ietf.org/html/rfc3849
1346 /// [`true`]: ../../std/primitive.bool.html
1353 /// use std::net::Ipv6Addr;
1355 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false);
1356 /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true);
1358 pub fn is_documentation(&self) -> bool {
1359 (self.segments()[0] == 0x2001) && (self.segments()[1] == 0xdb8)
1362 /// Returns [`true`] if the address is a globally routable unicast address.
1364 /// The following return false:
1366 /// - the loopback address
1367 /// - the link-local addresses
1368 /// - unique local addresses
1369 /// - the unspecified address
1370 /// - the address range reserved for documentation
1372 /// This method returns [`true`] for site-local addresses as per [RFC 4291 section 2.5.7]
1375 /// The special behavior of [the site-local unicast] prefix defined in [RFC3513] must no longer
1376 /// be supported in new implementations (i.e., new implementations must treat this prefix as
1377 /// Global Unicast).
1380 /// [`true`]: ../../std/primitive.bool.html
1381 /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1388 /// use std::net::Ipv6Addr;
1390 /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false);
1391 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true);
1393 pub fn is_unicast_global(&self) -> bool {
1394 !self.is_multicast()
1395 && !self.is_loopback()
1396 && !self.is_unicast_link_local()
1397 && !self.is_unique_local()
1398 && !self.is_unspecified()
1399 && !self.is_documentation()
1402 /// Returns the address's multicast scope if the address is multicast.
1409 /// use std::net::{Ipv6Addr, Ipv6MulticastScope};
1412 /// Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(),
1413 /// Some(Ipv6MulticastScope::Global)
1415 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None);
1417 pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope> {
1418 if self.is_multicast() {
1419 match self.segments()[0] & 0x000f {
1420 1 => Some(Ipv6MulticastScope::InterfaceLocal),
1421 2 => Some(Ipv6MulticastScope::LinkLocal),
1422 3 => Some(Ipv6MulticastScope::RealmLocal),
1423 4 => Some(Ipv6MulticastScope::AdminLocal),
1424 5 => Some(Ipv6MulticastScope::SiteLocal),
1425 8 => Some(Ipv6MulticastScope::OrganizationLocal),
1426 14 => Some(Ipv6MulticastScope::Global),
1434 /// Returns [`true`] if this is a multicast address (ff00::/8).
1436 /// This property is defined by [IETF RFC 4291].
1438 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1439 /// [`true`]: ../../std/primitive.bool.html
1444 /// use std::net::Ipv6Addr;
1446 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true);
1447 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);
1449 #[stable(since = "1.7.0", feature = "ip_17")]
1450 pub fn is_multicast(&self) -> bool {
1451 (self.segments()[0] & 0xff00) == 0xff00
1454 /// Converts this address to an [IPv4 address]. Returns [`None`] if this address is
1455 /// neither IPv4-compatible or IPv4-mapped.
1457 /// ::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d
1459 /// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
1460 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1465 /// use std::net::{Ipv4Addr, Ipv6Addr};
1467 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None);
1468 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(),
1469 /// Some(Ipv4Addr::new(192, 10, 2, 255)));
1470 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(),
1471 /// Some(Ipv4Addr::new(0, 0, 0, 1)));
1473 #[stable(feature = "rust1", since = "1.0.0")]
1474 pub fn to_ipv4(&self) -> Option<Ipv4Addr> {
1475 match self.segments() {
1476 [0, 0, 0, 0, 0, f, g, h] if f == 0 || f == 0xffff => {
1477 Some(Ipv4Addr::new((g >> 8) as u8, g as u8, (h >> 8) as u8, h as u8))
1483 /// Returns the sixteen eight-bit integers the IPv6 address consists of.
1486 /// use std::net::Ipv6Addr;
1488 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).octets(),
1489 /// [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
1491 #[stable(feature = "ipv6_to_octets", since = "1.12.0")]
1492 #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1493 pub const fn octets(&self) -> [u8; 16] {
1498 #[stable(feature = "rust1", since = "1.0.0")]
1499 impl fmt::Display for Ipv6Addr {
1500 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1501 // Note: The calls to write should never fail, hence the unwraps in the function
1502 // Long enough for the longest possible IPv6: 39
1503 const IPV6_BUF_LEN: usize = 39;
1504 let mut buf = [0u8; IPV6_BUF_LEN];
1505 let mut buf_slice = &mut buf[..];
1507 match self.segments() {
1508 // We need special cases for :: and ::1, otherwise they're formatted
1510 [0, 0, 0, 0, 0, 0, 0, 0] => write!(buf_slice, "::").unwrap(),
1511 [0, 0, 0, 0, 0, 0, 0, 1] => write!(buf_slice, "::1").unwrap(),
1512 // Ipv4 Compatible address
1513 [0, 0, 0, 0, 0, 0, g, h] => {
1524 // Ipv4-Mapped address
1525 [0, 0, 0, 0, 0, 0xffff, g, h] => {
1528 "::ffff:{}.{}.{}.{}",
1537 fn find_zero_slice(segments: &[u16; 8]) -> (usize, usize) {
1538 let mut longest_span_len = 0;
1539 let mut longest_span_at = 0;
1540 let mut cur_span_len = 0;
1541 let mut cur_span_at = 0;
1544 if segments[i] == 0 {
1545 if cur_span_len == 0 {
1551 if cur_span_len > longest_span_len {
1552 longest_span_len = cur_span_len;
1553 longest_span_at = cur_span_at;
1561 (longest_span_at, longest_span_len)
1564 let (zeros_at, zeros_len) = find_zero_slice(&self.segments());
1567 fn fmt_subslice(segments: &[u16], buf: &mut &mut [u8]) {
1568 if !segments.is_empty() {
1569 write!(*buf, "{:x}", segments[0]).unwrap();
1570 for &seg in &segments[1..] {
1571 write!(*buf, ":{:x}", seg).unwrap();
1576 fmt_subslice(&self.segments()[..zeros_at], &mut buf_slice);
1577 write!(buf_slice, "::").unwrap();
1578 fmt_subslice(&self.segments()[zeros_at + zeros_len..], &mut buf_slice);
1580 let &[a, b, c, d, e, f, g, h] = &self.segments();
1583 "{:x}:{:x}:{:x}:{:x}:{:x}:{:x}:{:x}:{:x}",
1584 a, b, c, d, e, f, g, h
1590 let len = IPV6_BUF_LEN - buf_slice.len();
1591 // This is safe because we know exactly what can be in this buffer
1592 let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
1597 #[stable(feature = "rust1", since = "1.0.0")]
1598 impl fmt::Debug for Ipv6Addr {
1599 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1600 fmt::Display::fmt(self, fmt)
1604 #[stable(feature = "rust1", since = "1.0.0")]
1605 impl Clone for Ipv6Addr {
1606 fn clone(&self) -> Ipv6Addr {
1611 #[stable(feature = "rust1", since = "1.0.0")]
1612 impl PartialEq for Ipv6Addr {
1613 fn eq(&self, other: &Ipv6Addr) -> bool {
1614 self.inner.s6_addr == other.inner.s6_addr
1618 #[stable(feature = "ip_cmp", since = "1.16.0")]
1619 impl PartialEq<IpAddr> for Ipv6Addr {
1620 fn eq(&self, other: &IpAddr) -> bool {
1622 IpAddr::V4(_) => false,
1623 IpAddr::V6(v6) => self == v6,
1628 #[stable(feature = "ip_cmp", since = "1.16.0")]
1629 impl PartialEq<Ipv6Addr> for IpAddr {
1630 fn eq(&self, other: &Ipv6Addr) -> bool {
1632 IpAddr::V4(_) => false,
1633 IpAddr::V6(v6) => v6 == other,
1638 #[stable(feature = "rust1", since = "1.0.0")]
1639 impl Eq for Ipv6Addr {}
1641 #[stable(feature = "rust1", since = "1.0.0")]
1642 impl hash::Hash for Ipv6Addr {
1643 fn hash<H: hash::Hasher>(&self, s: &mut H) {
1644 self.inner.s6_addr.hash(s)
1648 #[stable(feature = "rust1", since = "1.0.0")]
1649 impl PartialOrd for Ipv6Addr {
1650 fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1651 Some(self.cmp(other))
1655 #[stable(feature = "ip_cmp", since = "1.16.0")]
1656 impl PartialOrd<Ipv6Addr> for IpAddr {
1657 fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1659 IpAddr::V4(_) => Some(Ordering::Less),
1660 IpAddr::V6(v6) => v6.partial_cmp(other),
1665 #[stable(feature = "ip_cmp", since = "1.16.0")]
1666 impl PartialOrd<IpAddr> for Ipv6Addr {
1667 fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
1669 IpAddr::V4(_) => Some(Ordering::Greater),
1670 IpAddr::V6(v6) => self.partial_cmp(v6),
1675 #[stable(feature = "rust1", since = "1.0.0")]
1676 impl Ord for Ipv6Addr {
1677 fn cmp(&self, other: &Ipv6Addr) -> Ordering {
1678 self.segments().cmp(&other.segments())
1682 impl AsInner<c::in6_addr> for Ipv6Addr {
1683 fn as_inner(&self) -> &c::in6_addr {
1687 impl FromInner<c::in6_addr> for Ipv6Addr {
1688 fn from_inner(addr: c::in6_addr) -> Ipv6Addr {
1689 Ipv6Addr { inner: addr }
1693 #[stable(feature = "i128", since = "1.26.0")]
1694 impl From<Ipv6Addr> for u128 {
1695 /// Convert an `Ipv6Addr` into a host byte order `u128`.
1700 /// use std::net::Ipv6Addr;
1702 /// let addr = Ipv6Addr::new(
1703 /// 0x1020, 0x3040, 0x5060, 0x7080,
1704 /// 0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1706 /// assert_eq!(0x102030405060708090A0B0C0D0E0F00D_u128, u128::from(addr));
1708 fn from(ip: Ipv6Addr) -> u128 {
1709 let ip = ip.octets();
1710 u128::from_be_bytes(ip)
1713 #[stable(feature = "i128", since = "1.26.0")]
1714 impl From<u128> for Ipv6Addr {
1715 /// Convert a host byte order `u128` into an `Ipv6Addr`.
1720 /// use std::net::Ipv6Addr;
1722 /// let addr = Ipv6Addr::from(0x102030405060708090A0B0C0D0E0F00D_u128);
1725 /// 0x1020, 0x3040, 0x5060, 0x7080,
1726 /// 0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1730 fn from(ip: u128) -> Ipv6Addr {
1731 Ipv6Addr::from(ip.to_be_bytes())
1735 #[stable(feature = "ipv6_from_octets", since = "1.9.0")]
1736 impl From<[u8; 16]> for Ipv6Addr {
1737 fn from(octets: [u8; 16]) -> Ipv6Addr {
1738 let inner = c::in6_addr { s6_addr: octets };
1739 Ipv6Addr::from_inner(inner)
1743 #[stable(feature = "ipv6_from_segments", since = "1.16.0")]
1744 impl From<[u16; 8]> for Ipv6Addr {
1745 fn from(segments: [u16; 8]) -> Ipv6Addr {
1746 let [a, b, c, d, e, f, g, h] = segments;
1747 Ipv6Addr::new(a, b, c, d, e, f, g, h)
1751 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1752 impl From<[u8; 16]> for IpAddr {
1753 /// Creates an `IpAddr::V6` from a sixteen element byte array.
1758 /// use std::net::{IpAddr, Ipv6Addr};
1760 /// let addr = IpAddr::from([
1761 /// 25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
1762 /// 17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
1765 /// IpAddr::V6(Ipv6Addr::new(
1774 fn from(octets: [u8; 16]) -> IpAddr {
1775 IpAddr::V6(Ipv6Addr::from(octets))
1779 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1780 impl From<[u16; 8]> for IpAddr {
1781 /// Creates an `IpAddr::V6` from an eight element 16-bit array.
1786 /// use std::net::{IpAddr, Ipv6Addr};
1788 /// let addr = IpAddr::from([
1789 /// 525u16, 524u16, 523u16, 522u16,
1790 /// 521u16, 520u16, 519u16, 518u16,
1793 /// IpAddr::V6(Ipv6Addr::new(
1802 fn from(segments: [u16; 8]) -> IpAddr {
1803 IpAddr::V6(Ipv6Addr::from(segments))
1807 // Tests for this module
1808 #[cfg(all(test, not(target_os = "emscripten")))]
1810 use crate::net::test::{sa4, sa6, tsa};
1812 use crate::str::FromStr;
1815 fn test_from_str_ipv4() {
1816 assert_eq!(Ok(Ipv4Addr::new(127, 0, 0, 1)), "127.0.0.1".parse());
1817 assert_eq!(Ok(Ipv4Addr::new(255, 255, 255, 255)), "255.255.255.255".parse());
1818 assert_eq!(Ok(Ipv4Addr::new(0, 0, 0, 0)), "0.0.0.0".parse());
1821 let none: Option<Ipv4Addr> = "256.0.0.1".parse().ok();
1822 assert_eq!(None, none);
1824 let none: Option<Ipv4Addr> = "255.0.0".parse().ok();
1825 assert_eq!(None, none);
1827 let none: Option<Ipv4Addr> = "255.0.0.1.2".parse().ok();
1828 assert_eq!(None, none);
1829 // no number between dots
1830 let none: Option<Ipv4Addr> = "255.0..1".parse().ok();
1831 assert_eq!(None, none);
1835 fn test_from_str_ipv6() {
1836 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "0:0:0:0:0:0:0:0".parse());
1837 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "0:0:0:0:0:0:0:1".parse());
1839 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "::1".parse());
1840 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "::".parse());
1843 Ok(Ipv6Addr::new(0x2a02, 0x6b8, 0, 0, 0, 0, 0x11, 0x11)),
1844 "2a02:6b8::11:11".parse()
1848 let none: Option<Ipv6Addr> = "::00000".parse().ok();
1849 assert_eq!(None, none);
1851 let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7".parse().ok();
1852 assert_eq!(None, none);
1854 let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7:8:9".parse().ok();
1855 assert_eq!(None, none);
1857 let none: Option<Ipv6Addr> = "1:2:::6:7:8".parse().ok();
1858 assert_eq!(None, none);
1859 // two double colons
1860 let none: Option<Ipv6Addr> = "1:2::6::8".parse().ok();
1861 assert_eq!(None, none);
1862 // `::` indicating zero groups of zeros
1863 let none: Option<Ipv6Addr> = "1:2:3:4::5:6:7:8".parse().ok();
1864 assert_eq!(None, none);
1868 fn test_from_str_ipv4_in_ipv6() {
1869 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 545)), "::192.0.2.33".parse());
1871 Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0xFFFF, 49152, 545)),
1872 "::FFFF:192.0.2.33".parse()
1875 Ok(Ipv6Addr::new(0x64, 0xff9b, 0, 0, 0, 0, 49152, 545)),
1876 "64:ff9b::192.0.2.33".parse()
1879 Ok(Ipv6Addr::new(0x2001, 0xdb8, 0x122, 0xc000, 0x2, 0x2100, 49152, 545)),
1880 "2001:db8:122:c000:2:2100:192.0.2.33".parse()
1884 let none: Option<Ipv4Addr> = "::127.0.0.1:".parse().ok();
1885 assert_eq!(None, none);
1886 // not enough groups
1887 let none: Option<Ipv6Addr> = "1.2.3.4.5:127.0.0.1".parse().ok();
1888 assert_eq!(None, none);
1890 let none: Option<Ipv6Addr> = "1.2.3.4.5:6:7:127.0.0.1".parse().ok();
1891 assert_eq!(None, none);
1895 fn test_from_str_socket_addr() {
1896 assert_eq!(Ok(sa4(Ipv4Addr::new(77, 88, 21, 11), 80)), "77.88.21.11:80".parse());
1898 Ok(SocketAddrV4::new(Ipv4Addr::new(77, 88, 21, 11), 80)),
1899 "77.88.21.11:80".parse()
1902 Ok(sa6(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53)),
1903 "[2a02:6b8:0:1::1]:53".parse()
1906 Ok(SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53, 0, 0)),
1907 "[2a02:6b8:0:1::1]:53".parse()
1910 Ok(sa6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22)),
1911 "[::127.0.0.1]:22".parse()
1914 Ok(SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22, 0, 0)),
1915 "[::127.0.0.1]:22".parse()
1919 let none: Option<SocketAddr> = "127.0.0.1".parse().ok();
1920 assert_eq!(None, none);
1922 let none: Option<SocketAddr> = "127.0.0.1:".parse().ok();
1923 assert_eq!(None, none);
1924 // wrong brackets around v4
1925 let none: Option<SocketAddr> = "[127.0.0.1]:22".parse().ok();
1926 assert_eq!(None, none);
1927 // port out of range
1928 let none: Option<SocketAddr> = "127.0.0.1:123456".parse().ok();
1929 assert_eq!(None, none);
1933 fn ipv4_addr_to_string() {
1935 assert_eq!(Ipv4Addr::new(1, 1, 1, 1).to_string(), "1.1.1.1");
1937 assert_eq!(Ipv4Addr::new(127, 127, 127, 127).to_string(), "127.127.127.127");
1940 assert_eq!(&format!("{:16}", Ipv4Addr::new(1, 1, 1, 1)), "1.1.1.1 ");
1941 assert_eq!(&format!("{:>16}", Ipv4Addr::new(1, 1, 1, 1)), " 1.1.1.1");
1945 fn ipv6_addr_to_string() {
1946 // ipv4-mapped address
1947 let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc000, 0x280);
1948 assert_eq!(a1.to_string(), "::ffff:192.0.2.128");
1950 // ipv4-compatible address
1951 let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0xc000, 0x280);
1952 assert_eq!(a1.to_string(), "::192.0.2.128");
1954 // v6 address with no zero segments
1955 assert_eq!(Ipv6Addr::new(8, 9, 10, 11, 12, 13, 14, 15).to_string(), "8:9:a:b:c:d:e:f");
1957 // longest possible IPv6 length
1959 Ipv6Addr::new(0x1111, 0x2222, 0x3333, 0x4444, 0x5555, 0x6666, 0x7777, 0x8888)
1961 "1111:2222:3333:4444:5555:6666:7777:8888"
1965 &format!("{:20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
1969 &format!("{:>20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
1973 // reduce a single run of zeros
1976 Ipv6Addr::new(0xae, 0, 0, 0, 0, 0xffff, 0x0102, 0x0304).to_string()
1979 // don't reduce just a single zero segment
1980 assert_eq!("1:2:3:4:5:6:0:8", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 0, 8).to_string());
1983 assert_eq!("::", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).to_string());
1986 assert_eq!("::1", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_string());
1989 assert_eq!("1::", Ipv6Addr::new(1, 0, 0, 0, 0, 0, 0, 0).to_string());
1991 // two runs of zeros, second one is longer
1992 assert_eq!("1:0:0:4::8", Ipv6Addr::new(1, 0, 0, 4, 0, 0, 0, 8).to_string());
1994 // two runs of zeros, equal length
1995 assert_eq!("1::4:5:0:0:8", Ipv6Addr::new(1, 0, 0, 4, 5, 0, 0, 8).to_string());
2001 Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678),
2002 Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_mapped()
2005 Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678),
2006 Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_compatible()
2013 Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678).to_ipv4(),
2014 Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2017 Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678).to_ipv4(),
2018 Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2020 assert_eq!(Ipv6Addr::new(0, 0, 1, 0, 0, 0, 0x1234, 0x5678).to_ipv4(), None);
2024 fn ip_properties() {
2027 IpAddr::from_str($s).unwrap()
2031 macro_rules! check {
2036 ($s:expr, $mask:expr) => {{
2037 let unspec: u8 = 1 << 0;
2038 let loopback: u8 = 1 << 1;
2039 let global: u8 = 1 << 2;
2040 let multicast: u8 = 1 << 3;
2041 let doc: u8 = 1 << 4;
2043 if ($mask & unspec) == unspec {
2044 assert!(ip!($s).is_unspecified());
2046 assert!(!ip!($s).is_unspecified());
2049 if ($mask & loopback) == loopback {
2050 assert!(ip!($s).is_loopback());
2052 assert!(!ip!($s).is_loopback());
2055 if ($mask & global) == global {
2056 assert!(ip!($s).is_global());
2058 assert!(!ip!($s).is_global());
2061 if ($mask & multicast) == multicast {
2062 assert!(ip!($s).is_multicast());
2064 assert!(!ip!($s).is_multicast());
2067 if ($mask & doc) == doc {
2068 assert!(ip!($s).is_documentation());
2070 assert!(!ip!($s).is_documentation());
2075 let unspec: u8 = 1 << 0;
2076 let loopback: u8 = 1 << 1;
2077 let global: u8 = 1 << 2;
2078 let multicast: u8 = 1 << 3;
2079 let doc: u8 = 1 << 4;
2081 check!("0.0.0.0", unspec);
2085 check!("127.1.2.3", loopback);
2086 check!("172.31.254.253");
2087 check!("169.254.253.242");
2088 check!("192.0.2.183", doc);
2089 check!("192.1.2.183", global);
2090 check!("192.168.254.253");
2091 check!("198.51.100.0", doc);
2092 check!("203.0.113.0", doc);
2093 check!("203.2.113.0", global);
2094 check!("224.0.0.0", global | multicast);
2095 check!("239.255.255.255", global | multicast);
2096 check!("255.255.255.255");
2097 // make sure benchmarking addresses are not global
2098 check!("198.18.0.0");
2099 check!("198.18.54.2");
2100 check!("198.19.255.255");
2101 // make sure addresses reserved for protocol assignment are not global
2102 check!("192.0.0.0");
2103 check!("192.0.0.255");
2104 check!("192.0.0.100");
2105 // make sure reserved addresses are not global
2106 check!("240.0.0.0");
2107 check!("251.54.1.76");
2108 check!("254.255.255.255");
2109 // make sure shared addresses are not global
2110 check!("100.64.0.0");
2111 check!("100.127.255.255");
2112 check!("100.100.100.0");
2114 check!("::", unspec);
2115 check!("::1", loopback);
2116 check!("::0.0.0.2", global);
2117 check!("1::", global);
2119 check!("fdff:ffff::");
2120 check!("fe80:ffff::");
2121 check!("febf:ffff::");
2122 check!("fec0::", global);
2123 check!("ff01::", multicast);
2124 check!("ff02::", multicast);
2125 check!("ff03::", multicast);
2126 check!("ff04::", multicast);
2127 check!("ff05::", multicast);
2128 check!("ff08::", multicast);
2129 check!("ff0e::", global | multicast);
2130 check!("2001:db8:85a3::8a2e:370:7334", doc);
2131 check!("102:304:506:708:90a:b0c:d0e:f10", global);
2135 fn ipv4_properties() {
2138 Ipv4Addr::from_str($s).unwrap()
2142 macro_rules! check {
2147 ($s:expr, $mask:expr) => {{
2148 let unspec: u16 = 1 << 0;
2149 let loopback: u16 = 1 << 1;
2150 let private: u16 = 1 << 2;
2151 let link_local: u16 = 1 << 3;
2152 let global: u16 = 1 << 4;
2153 let multicast: u16 = 1 << 5;
2154 let broadcast: u16 = 1 << 6;
2155 let documentation: u16 = 1 << 7;
2156 let benchmarking: u16 = 1 << 8;
2157 let ietf_protocol_assignment: u16 = 1 << 9;
2158 let reserved: u16 = 1 << 10;
2159 let shared: u16 = 1 << 11;
2161 if ($mask & unspec) == unspec {
2162 assert!(ip!($s).is_unspecified());
2164 assert!(!ip!($s).is_unspecified());
2167 if ($mask & loopback) == loopback {
2168 assert!(ip!($s).is_loopback());
2170 assert!(!ip!($s).is_loopback());
2173 if ($mask & private) == private {
2174 assert!(ip!($s).is_private());
2176 assert!(!ip!($s).is_private());
2179 if ($mask & link_local) == link_local {
2180 assert!(ip!($s).is_link_local());
2182 assert!(!ip!($s).is_link_local());
2185 if ($mask & global) == global {
2186 assert!(ip!($s).is_global());
2188 assert!(!ip!($s).is_global());
2191 if ($mask & multicast) == multicast {
2192 assert!(ip!($s).is_multicast());
2194 assert!(!ip!($s).is_multicast());
2197 if ($mask & broadcast) == broadcast {
2198 assert!(ip!($s).is_broadcast());
2200 assert!(!ip!($s).is_broadcast());
2203 if ($mask & documentation) == documentation {
2204 assert!(ip!($s).is_documentation());
2206 assert!(!ip!($s).is_documentation());
2209 if ($mask & benchmarking) == benchmarking {
2210 assert!(ip!($s).is_benchmarking());
2212 assert!(!ip!($s).is_benchmarking());
2215 if ($mask & ietf_protocol_assignment) == ietf_protocol_assignment {
2216 assert!(ip!($s).is_ietf_protocol_assignment());
2218 assert!(!ip!($s).is_ietf_protocol_assignment());
2221 if ($mask & reserved) == reserved {
2222 assert!(ip!($s).is_reserved());
2224 assert!(!ip!($s).is_reserved());
2227 if ($mask & shared) == shared {
2228 assert!(ip!($s).is_shared());
2230 assert!(!ip!($s).is_shared());
2235 let unspec: u16 = 1 << 0;
2236 let loopback: u16 = 1 << 1;
2237 let private: u16 = 1 << 2;
2238 let link_local: u16 = 1 << 3;
2239 let global: u16 = 1 << 4;
2240 let multicast: u16 = 1 << 5;
2241 let broadcast: u16 = 1 << 6;
2242 let documentation: u16 = 1 << 7;
2243 let benchmarking: u16 = 1 << 8;
2244 let ietf_protocol_assignment: u16 = 1 << 9;
2245 let reserved: u16 = 1 << 10;
2246 let shared: u16 = 1 << 11;
2248 check!("0.0.0.0", unspec);
2251 check!("10.9.8.7", private);
2252 check!("127.1.2.3", loopback);
2253 check!("172.31.254.253", private);
2254 check!("169.254.253.242", link_local);
2255 check!("192.0.2.183", documentation);
2256 check!("192.1.2.183", global);
2257 check!("192.168.254.253", private);
2258 check!("198.51.100.0", documentation);
2259 check!("203.0.113.0", documentation);
2260 check!("203.2.113.0", global);
2261 check!("224.0.0.0", global | multicast);
2262 check!("239.255.255.255", global | multicast);
2263 check!("255.255.255.255", broadcast);
2264 check!("198.18.0.0", benchmarking);
2265 check!("198.18.54.2", benchmarking);
2266 check!("198.19.255.255", benchmarking);
2267 check!("192.0.0.0", ietf_protocol_assignment);
2268 check!("192.0.0.255", ietf_protocol_assignment);
2269 check!("192.0.0.100", ietf_protocol_assignment);
2270 check!("240.0.0.0", reserved);
2271 check!("251.54.1.76", reserved);
2272 check!("254.255.255.255", reserved);
2273 check!("100.64.0.0", shared);
2274 check!("100.127.255.255", shared);
2275 check!("100.100.100.0", shared);
2279 fn ipv6_properties() {
2282 Ipv6Addr::from_str($s).unwrap()
2286 macro_rules! check {
2287 ($s:expr, &[$($octet:expr),*], $mask:expr) => {
2288 assert_eq!($s, ip!($s).to_string());
2289 let octets = &[$($octet),*];
2290 assert_eq!(&ip!($s).octets(), octets);
2291 assert_eq!(Ipv6Addr::from(*octets), ip!($s));
2293 let unspecified: u16 = 1 << 0;
2294 let loopback: u16 = 1 << 1;
2295 let unique_local: u16 = 1 << 2;
2296 let global: u16 = 1 << 3;
2297 let unicast_link_local: u16 = 1 << 4;
2298 let unicast_link_local_strict: u16 = 1 << 5;
2299 let unicast_site_local: u16 = 1 << 6;
2300 let unicast_global: u16 = 1 << 7;
2301 let documentation: u16 = 1 << 8;
2302 let multicast_interface_local: u16 = 1 << 9;
2303 let multicast_link_local: u16 = 1 << 10;
2304 let multicast_realm_local: u16 = 1 << 11;
2305 let multicast_admin_local: u16 = 1 << 12;
2306 let multicast_site_local: u16 = 1 << 13;
2307 let multicast_organization_local: u16 = 1 << 14;
2308 let multicast_global: u16 = 1 << 15;
2309 let multicast: u16 = multicast_interface_local
2310 | multicast_admin_local
2312 | multicast_link_local
2313 | multicast_realm_local
2314 | multicast_site_local
2315 | multicast_organization_local;
2317 if ($mask & unspecified) == unspecified {
2318 assert!(ip!($s).is_unspecified());
2320 assert!(!ip!($s).is_unspecified());
2322 if ($mask & loopback) == loopback {
2323 assert!(ip!($s).is_loopback());
2325 assert!(!ip!($s).is_loopback());
2327 if ($mask & unique_local) == unique_local {
2328 assert!(ip!($s).is_unique_local());
2330 assert!(!ip!($s).is_unique_local());
2332 if ($mask & global) == global {
2333 assert!(ip!($s).is_global());
2335 assert!(!ip!($s).is_global());
2337 if ($mask & unicast_link_local) == unicast_link_local {
2338 assert!(ip!($s).is_unicast_link_local());
2340 assert!(!ip!($s).is_unicast_link_local());
2342 if ($mask & unicast_link_local_strict) == unicast_link_local_strict {
2343 assert!(ip!($s).is_unicast_link_local_strict());
2345 assert!(!ip!($s).is_unicast_link_local_strict());
2347 if ($mask & unicast_site_local) == unicast_site_local {
2348 assert!(ip!($s).is_unicast_site_local());
2350 assert!(!ip!($s).is_unicast_site_local());
2352 if ($mask & unicast_global) == unicast_global {
2353 assert!(ip!($s).is_unicast_global());
2355 assert!(!ip!($s).is_unicast_global());
2357 if ($mask & documentation) == documentation {
2358 assert!(ip!($s).is_documentation());
2360 assert!(!ip!($s).is_documentation());
2362 if ($mask & multicast) != 0 {
2363 assert!(ip!($s).multicast_scope().is_some());
2364 assert!(ip!($s).is_multicast());
2366 assert!(ip!($s).multicast_scope().is_none());
2367 assert!(!ip!($s).is_multicast());
2369 if ($mask & multicast_interface_local) == multicast_interface_local {
2370 assert_eq!(ip!($s).multicast_scope().unwrap(),
2371 Ipv6MulticastScope::InterfaceLocal);
2373 if ($mask & multicast_link_local) == multicast_link_local {
2374 assert_eq!(ip!($s).multicast_scope().unwrap(),
2375 Ipv6MulticastScope::LinkLocal);
2377 if ($mask & multicast_realm_local) == multicast_realm_local {
2378 assert_eq!(ip!($s).multicast_scope().unwrap(),
2379 Ipv6MulticastScope::RealmLocal);
2381 if ($mask & multicast_admin_local) == multicast_admin_local {
2382 assert_eq!(ip!($s).multicast_scope().unwrap(),
2383 Ipv6MulticastScope::AdminLocal);
2385 if ($mask & multicast_site_local) == multicast_site_local {
2386 assert_eq!(ip!($s).multicast_scope().unwrap(),
2387 Ipv6MulticastScope::SiteLocal);
2389 if ($mask & multicast_organization_local) == multicast_organization_local {
2390 assert_eq!(ip!($s).multicast_scope().unwrap(),
2391 Ipv6MulticastScope::OrganizationLocal);
2393 if ($mask & multicast_global) == multicast_global {
2394 assert_eq!(ip!($s).multicast_scope().unwrap(),
2395 Ipv6MulticastScope::Global);
2400 let unspecified: u16 = 1 << 0;
2401 let loopback: u16 = 1 << 1;
2402 let unique_local: u16 = 1 << 2;
2403 let global: u16 = 1 << 3;
2404 let unicast_link_local: u16 = 1 << 4;
2405 let unicast_link_local_strict: u16 = 1 << 5;
2406 let unicast_site_local: u16 = 1 << 6;
2407 let unicast_global: u16 = 1 << 7;
2408 let documentation: u16 = 1 << 8;
2409 let multicast_interface_local: u16 = 1 << 9;
2410 let multicast_link_local: u16 = 1 << 10;
2411 let multicast_realm_local: u16 = 1 << 11;
2412 let multicast_admin_local: u16 = 1 << 12;
2413 let multicast_site_local: u16 = 1 << 13;
2414 let multicast_organization_local: u16 = 1 << 14;
2415 let multicast_global: u16 = 1 << 15;
2417 check!("::", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unspecified);
2419 check!("::1", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1], loopback);
2423 &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2],
2424 global | unicast_global
2427 check!("1::", &[0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], global | unicast_global);
2429 check!("fc00::", &[0xfc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unique_local);
2433 &[0xfd, 0xff, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2439 &[0xfe, 0x80, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2445 &[0xfe, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2446 unicast_link_local | unicast_link_local_strict
2451 &[0xfe, 0xbf, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2457 &[0xfe, 0xbf, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2462 "febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
2464 0xfe, 0xbf, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2471 "fe80::ffff:ffff:ffff:ffff",
2473 0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2476 unicast_link_local | unicast_link_local_strict
2481 &[0xfe, 0x80, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
2487 &[0xfe, 0xc0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2488 unicast_site_local | unicast_global | global
2493 &[0xff, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2494 multicast_interface_local
2499 &[0xff, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2500 multicast_link_local
2505 &[0xff, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2506 multicast_realm_local
2511 &[0xff, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2512 multicast_admin_local
2517 &[0xff, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2518 multicast_site_local
2523 &[0xff, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2524 multicast_organization_local
2529 &[0xff, 0xe, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2530 multicast_global | global
2534 "2001:db8:85a3::8a2e:370:7334",
2535 &[0x20, 1, 0xd, 0xb8, 0x85, 0xa3, 0, 0, 0, 0, 0x8a, 0x2e, 3, 0x70, 0x73, 0x34],
2540 "102:304:506:708:90a:b0c:d0e:f10",
2541 &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16],
2542 global | unicast_global
2547 fn to_socket_addr_socketaddr() {
2548 let a = sa4(Ipv4Addr::new(77, 88, 21, 11), 12345);
2549 assert_eq!(Ok(vec![a]), tsa(a));
2553 fn test_ipv4_to_int() {
2554 let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2555 assert_eq!(u32::from(a), 0x11223344);
2559 fn test_int_to_ipv4() {
2560 let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2561 assert_eq!(Ipv4Addr::from(0x11223344), a);
2565 fn test_ipv6_to_int() {
2566 let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2567 assert_eq!(u128::from(a), 0x112233445566778899aabbccddeeff11u128);
2571 fn test_int_to_ipv6() {
2572 let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2573 assert_eq!(Ipv6Addr::from(0x112233445566778899aabbccddeeff11u128), a);
2577 fn ipv4_from_constructors() {
2578 assert_eq!(Ipv4Addr::LOCALHOST, Ipv4Addr::new(127, 0, 0, 1));
2579 assert!(Ipv4Addr::LOCALHOST.is_loopback());
2580 assert_eq!(Ipv4Addr::UNSPECIFIED, Ipv4Addr::new(0, 0, 0, 0));
2581 assert!(Ipv4Addr::UNSPECIFIED.is_unspecified());
2582 assert_eq!(Ipv4Addr::BROADCAST, Ipv4Addr::new(255, 255, 255, 255));
2583 assert!(Ipv4Addr::BROADCAST.is_broadcast());
2587 fn ipv6_from_contructors() {
2588 assert_eq!(Ipv6Addr::LOCALHOST, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
2589 assert!(Ipv6Addr::LOCALHOST.is_loopback());
2590 assert_eq!(Ipv6Addr::UNSPECIFIED, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
2591 assert!(Ipv6Addr::UNSPECIFIED.is_unspecified());
2595 fn ipv4_from_octets() {
2596 assert_eq!(Ipv4Addr::from([127, 0, 0, 1]), Ipv4Addr::new(127, 0, 0, 1))
2600 fn ipv6_from_segments() {
2602 Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2603 let new = Ipv6Addr::new(0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff);
2604 assert_eq!(new, from_u16s);
2608 fn ipv6_from_octets() {
2610 Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2611 let from_u8s = Ipv6Addr::from([
2612 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd,
2615 assert_eq!(from_u16s, from_u8s);
2620 let v41 = Ipv4Addr::new(100, 64, 3, 3);
2621 let v42 = Ipv4Addr::new(192, 0, 2, 2);
2622 let v61 = "2001:db8:f00::1002".parse::<Ipv6Addr>().unwrap();
2623 let v62 = "2001:db8:f00::2001".parse::<Ipv6Addr>().unwrap();
2627 assert_eq!(v41, IpAddr::V4(v41));
2628 assert_eq!(v61, IpAddr::V6(v61));
2629 assert!(v41 != IpAddr::V4(v42));
2630 assert!(v61 != IpAddr::V6(v62));
2632 assert!(v41 < IpAddr::V4(v42));
2633 assert!(v61 < IpAddr::V6(v62));
2634 assert!(IpAddr::V4(v41) < v42);
2635 assert!(IpAddr::V6(v61) < v62);
2637 assert!(v41 < IpAddr::V6(v61));
2638 assert!(IpAddr::V4(v41) < v61);
2643 let ip = IpAddr::V4(Ipv4Addr::new(100, 64, 3, 3));
2644 assert!(ip.is_ipv4());
2645 assert!(!ip.is_ipv6());
2650 let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678));
2651 assert!(!ip.is_ipv4());
2652 assert!(ip.is_ipv6());