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 {
285 IpAddr::V4(_) => true,
286 IpAddr::V6(_) => false,
290 /// Returns [`true`] if this address is an [IPv6 address], and [`false`] otherwise.
292 /// [`true`]: ../../std/primitive.bool.html
293 /// [`false`]: ../../std/primitive.bool.html
294 /// [IPv6 address]: #variant.V6
299 /// use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
301 /// assert_eq!(IpAddr::V4(Ipv4Addr::new(203, 0, 113, 6)).is_ipv6(), false);
302 /// assert_eq!(IpAddr::V6(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0)).is_ipv6(), true);
304 #[stable(feature = "ipaddr_checker", since = "1.16.0")]
305 pub fn is_ipv6(&self) -> bool {
307 IpAddr::V4(_) => false,
308 IpAddr::V6(_) => true,
314 /// Creates a new IPv4 address from four eight-bit octets.
316 /// The result will represent the IP address `a`.`b`.`c`.`d`.
321 /// use std::net::Ipv4Addr;
323 /// let addr = Ipv4Addr::new(127, 0, 0, 1);
325 #[stable(feature = "rust1", since = "1.0.0")]
326 #[rustc_const_stable(feature = "const_ipv4", since = "1.32.0")]
327 pub const fn new(a: u8, b: u8, c: u8, d: u8) -> Ipv4Addr {
328 // FIXME: should just be u32::from_be_bytes([a, b, c, d]),
329 // once that method is no longer rustc_const_unstable
333 ((a as u32) << 24) | ((b as u32) << 16) | ((c as u32) << 8) | (d as u32),
339 /// An IPv4 address with the address pointing to localhost: 127.0.0.1.
344 /// use std::net::Ipv4Addr;
346 /// let addr = Ipv4Addr::LOCALHOST;
347 /// assert_eq!(addr, Ipv4Addr::new(127, 0, 0, 1));
349 #[stable(feature = "ip_constructors", since = "1.30.0")]
350 pub const LOCALHOST: Self = Ipv4Addr::new(127, 0, 0, 1);
352 /// An IPv4 address representing an unspecified address: 0.0.0.0
357 /// use std::net::Ipv4Addr;
359 /// let addr = Ipv4Addr::UNSPECIFIED;
360 /// assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));
362 #[stable(feature = "ip_constructors", since = "1.30.0")]
363 pub const UNSPECIFIED: Self = Ipv4Addr::new(0, 0, 0, 0);
365 /// An IPv4 address representing the broadcast address: 255.255.255.255
370 /// use std::net::Ipv4Addr;
372 /// let addr = Ipv4Addr::BROADCAST;
373 /// assert_eq!(addr, Ipv4Addr::new(255, 255, 255, 255));
375 #[stable(feature = "ip_constructors", since = "1.30.0")]
376 pub const BROADCAST: Self = Ipv4Addr::new(255, 255, 255, 255);
378 /// Returns the four eight-bit integers that make up this address.
383 /// use std::net::Ipv4Addr;
385 /// let addr = Ipv4Addr::new(127, 0, 0, 1);
386 /// assert_eq!(addr.octets(), [127, 0, 0, 1]);
388 #[stable(feature = "rust1", since = "1.0.0")]
389 pub fn octets(&self) -> [u8; 4] {
390 // This returns the order we want because s_addr is stored in big-endian.
391 self.inner.s_addr.to_ne_bytes()
394 /// Returns [`true`] for the special 'unspecified' address (0.0.0.0).
396 /// This property is defined in _UNIX Network Programming, Second Edition_,
397 /// W. Richard Stevens, p. 891; see also [ip7].
399 /// [ip7]: http://man7.org/linux/man-pages/man7/ip.7.html
400 /// [`true`]: ../../std/primitive.bool.html
405 /// use std::net::Ipv4Addr;
407 /// assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_unspecified(), true);
408 /// assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_unspecified(), false);
410 #[stable(feature = "ip_shared", since = "1.12.0")]
411 #[rustc_const_stable(feature = "const_ipv4", since = "1.32.0")]
412 pub const fn is_unspecified(&self) -> bool {
413 self.inner.s_addr == 0
416 /// Returns [`true`] if this is a loopback address (127.0.0.0/8).
418 /// This property is defined by [IETF RFC 1122].
420 /// [IETF RFC 1122]: https://tools.ietf.org/html/rfc1122
421 /// [`true`]: ../../std/primitive.bool.html
426 /// use std::net::Ipv4Addr;
428 /// assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_loopback(), true);
429 /// assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_loopback(), false);
431 #[stable(since = "1.7.0", feature = "ip_17")]
432 pub fn is_loopback(&self) -> bool {
433 self.octets()[0] == 127
436 /// Returns [`true`] if this is a private address.
438 /// The private address ranges are defined in [IETF RFC 1918] and include:
444 /// [IETF RFC 1918]: https://tools.ietf.org/html/rfc1918
445 /// [`true`]: ../../std/primitive.bool.html
450 /// use std::net::Ipv4Addr;
452 /// assert_eq!(Ipv4Addr::new(10, 0, 0, 1).is_private(), true);
453 /// assert_eq!(Ipv4Addr::new(10, 10, 10, 10).is_private(), true);
454 /// assert_eq!(Ipv4Addr::new(172, 16, 10, 10).is_private(), true);
455 /// assert_eq!(Ipv4Addr::new(172, 29, 45, 14).is_private(), true);
456 /// assert_eq!(Ipv4Addr::new(172, 32, 0, 2).is_private(), false);
457 /// assert_eq!(Ipv4Addr::new(192, 168, 0, 2).is_private(), true);
458 /// assert_eq!(Ipv4Addr::new(192, 169, 0, 2).is_private(), false);
460 #[stable(since = "1.7.0", feature = "ip_17")]
461 pub fn is_private(&self) -> bool {
462 match self.octets() {
464 [172, b, ..] if b >= 16 && b <= 31 => true,
465 [192, 168, ..] => true,
470 /// Returns [`true`] if the address is link-local (169.254.0.0/16).
472 /// This property is defined by [IETF RFC 3927].
474 /// [IETF RFC 3927]: https://tools.ietf.org/html/rfc3927
475 /// [`true`]: ../../std/primitive.bool.html
480 /// use std::net::Ipv4Addr;
482 /// assert_eq!(Ipv4Addr::new(169, 254, 0, 0).is_link_local(), true);
483 /// assert_eq!(Ipv4Addr::new(169, 254, 10, 65).is_link_local(), true);
484 /// assert_eq!(Ipv4Addr::new(16, 89, 10, 65).is_link_local(), false);
486 #[stable(since = "1.7.0", feature = "ip_17")]
487 pub fn is_link_local(&self) -> bool {
488 match self.octets() {
489 [169, 254, ..] => true,
494 /// Returns [`true`] if the address appears to be globally routable.
495 /// See [iana-ipv4-special-registry][ipv4-sr].
497 /// The following return false:
499 /// - private addresses (see [`is_private()`](#method.is_private))
500 /// - the loopback address (see [`is_loopback()`](#method.is_loopback))
501 /// - the link-local address (see [`is_link_local()`](#method.is_link_local))
502 /// - the broadcast address (see [`is_broadcast()`](#method.is_broadcast))
503 /// - addresses used for documentation (see [`is_documentation()`](#method.is_documentation))
504 /// - the unspecified address (see [`is_unspecified()`](#method.is_unspecified)), and the whole
506 /// - addresses reserved for future protocols (see
507 /// [`is_ietf_protocol_assignment()`](#method.is_ietf_protocol_assignment), except
508 /// `192.0.0.9/32` and `192.0.0.10/32` which are globally routable
509 /// - addresses reserved for future use (see [`is_reserved()`](#method.is_reserved)
510 /// - addresses reserved for networking devices benchmarking (see
511 /// [`is_benchmarking`](#method.is_benchmarking))
513 /// [ipv4-sr]: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
514 /// [`true`]: ../../std/primitive.bool.html
521 /// use std::net::Ipv4Addr;
523 /// // private addresses are not global
524 /// assert_eq!(Ipv4Addr::new(10, 254, 0, 0).is_global(), false);
525 /// assert_eq!(Ipv4Addr::new(192, 168, 10, 65).is_global(), false);
526 /// assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_global(), false);
528 /// // the 0.0.0.0/8 block is not global
529 /// assert_eq!(Ipv4Addr::new(0, 1, 2, 3).is_global(), false);
530 /// // in particular, the unspecified address is not global
531 /// assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_global(), false);
533 /// // the loopback address is not global
534 /// assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_global(), false);
536 /// // link local addresses are not global
537 /// assert_eq!(Ipv4Addr::new(169, 254, 45, 1).is_global(), false);
539 /// // the broadcast address is not global
540 /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_global(), false);
542 /// // the address space designated for documentation is not global
543 /// assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_global(), false);
544 /// assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_global(), false);
545 /// assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_global(), false);
547 /// // shared addresses are not global
548 /// assert_eq!(Ipv4Addr::new(100, 100, 0, 0).is_global(), false);
550 /// // addresses reserved for protocol assignment are not global
551 /// assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_global(), false);
552 /// assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_global(), false);
554 /// // addresses reserved for future use are not global
555 /// assert_eq!(Ipv4Addr::new(250, 10, 20, 30).is_global(), false);
557 /// // addresses reserved for network devices benchmarking are not global
558 /// assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_global(), false);
560 /// // All the other addresses are global
561 /// assert_eq!(Ipv4Addr::new(1, 1, 1, 1).is_global(), true);
562 /// assert_eq!(Ipv4Addr::new(80, 9, 12, 3).is_global(), true);
564 pub fn is_global(&self) -> bool {
565 // check if this address is 192.0.0.9 or 192.0.0.10. These addresses are the only two
566 // globally routable addresses in the 192.0.0.0/24 range.
567 if u32::from(*self) == 0xc0000009 || u32::from(*self) == 0xc000000a {
571 && !self.is_loopback()
572 && !self.is_link_local()
573 && !self.is_broadcast()
574 && !self.is_documentation()
576 && !self.is_ietf_protocol_assignment()
577 && !self.is_reserved()
578 && !self.is_benchmarking()
579 // Make sure the address is not in 0.0.0.0/8
580 && self.octets()[0] != 0
583 /// Returns [`true`] if this address is part of the Shared Address Space defined in
584 /// [IETF RFC 6598] (`100.64.0.0/10`).
586 /// [IETF RFC 6598]: https://tools.ietf.org/html/rfc6598
587 /// [`true`]: ../../std/primitive.bool.html
593 /// use std::net::Ipv4Addr;
595 /// assert_eq!(Ipv4Addr::new(100, 64, 0, 0).is_shared(), true);
596 /// assert_eq!(Ipv4Addr::new(100, 127, 255, 255).is_shared(), true);
597 /// assert_eq!(Ipv4Addr::new(100, 128, 0, 0).is_shared(), false);
599 pub fn is_shared(&self) -> bool {
600 self.octets()[0] == 100 && (self.octets()[1] & 0b1100_0000 == 0b0100_0000)
603 /// Returns [`true`] if this address is part of `192.0.0.0/24`, which is reserved to
604 /// IANA for IETF protocol assignments, as documented in [IETF RFC 6890].
606 /// Note that parts of this block are in use:
608 /// - `192.0.0.8/32` is the "IPv4 dummy address" (see [IETF RFC 7600])
609 /// - `192.0.0.9/32` is the "Port Control Protocol Anycast" (see [IETF RFC 7723])
610 /// - `192.0.0.10/32` is used for NAT traversal (see [IETF RFC 8155])
612 /// [IETF RFC 6890]: https://tools.ietf.org/html/rfc6890
613 /// [IETF RFC 7600]: https://tools.ietf.org/html/rfc7600
614 /// [IETF RFC 7723]: https://tools.ietf.org/html/rfc7723
615 /// [IETF RFC 8155]: https://tools.ietf.org/html/rfc8155
616 /// [`true`]: ../../std/primitive.bool.html
622 /// use std::net::Ipv4Addr;
624 /// assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_ietf_protocol_assignment(), true);
625 /// assert_eq!(Ipv4Addr::new(192, 0, 0, 8).is_ietf_protocol_assignment(), true);
626 /// assert_eq!(Ipv4Addr::new(192, 0, 0, 9).is_ietf_protocol_assignment(), true);
627 /// assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_ietf_protocol_assignment(), true);
628 /// assert_eq!(Ipv4Addr::new(192, 0, 1, 0).is_ietf_protocol_assignment(), false);
629 /// assert_eq!(Ipv4Addr::new(191, 255, 255, 255).is_ietf_protocol_assignment(), false);
631 pub fn is_ietf_protocol_assignment(&self) -> bool {
632 self.octets()[0] == 192 && self.octets()[1] == 0 && self.octets()[2] == 0
635 /// Returns [`true`] if this address part of the `198.18.0.0/15` range, which is reserved for
636 /// network devices benchmarking. This range is defined in [IETF RFC 2544] as `192.18.0.0`
637 /// through `198.19.255.255` but [errata 423] corrects it to `198.18.0.0/15`.
639 /// [IETF RFC 2544]: https://tools.ietf.org/html/rfc2544
640 /// [errata 423]: https://www.rfc-editor.org/errata/eid423
641 /// [`true`]: ../../std/primitive.bool.html
647 /// use std::net::Ipv4Addr;
649 /// assert_eq!(Ipv4Addr::new(198, 17, 255, 255).is_benchmarking(), false);
650 /// assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_benchmarking(), true);
651 /// assert_eq!(Ipv4Addr::new(198, 19, 255, 255).is_benchmarking(), true);
652 /// assert_eq!(Ipv4Addr::new(198, 20, 0, 0).is_benchmarking(), false);
654 pub fn is_benchmarking(&self) -> bool {
655 self.octets()[0] == 198 && (self.octets()[1] & 0xfe) == 18
658 /// Returns [`true`] if this address is reserved by IANA for future use. [IETF RFC 1112]
659 /// defines the block of reserved addresses as `240.0.0.0/4`. This range normally includes the
660 /// broadcast address `255.255.255.255`, but this implementation explicitely excludes it, since
661 /// it is obviously not reserved for future use.
663 /// [IETF RFC 1112]: https://tools.ietf.org/html/rfc1112
664 /// [`true`]: ../../std/primitive.bool.html
668 /// As IANA assigns new addresses, this method will be
669 /// updated. This may result in non-reserved addresses being
670 /// treated as reserved in code that relies on an outdated version
677 /// use std::net::Ipv4Addr;
679 /// assert_eq!(Ipv4Addr::new(240, 0, 0, 0).is_reserved(), true);
680 /// assert_eq!(Ipv4Addr::new(255, 255, 255, 254).is_reserved(), true);
682 /// assert_eq!(Ipv4Addr::new(239, 255, 255, 255).is_reserved(), false);
683 /// // The broadcast address is not considered as reserved for future use by this implementation
684 /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_reserved(), false);
686 pub fn is_reserved(&self) -> bool {
687 self.octets()[0] & 240 == 240 && !self.is_broadcast()
690 /// Returns [`true`] if this is a multicast address (224.0.0.0/4).
692 /// Multicast addresses have a most significant octet between 224 and 239,
693 /// and is defined by [IETF RFC 5771].
695 /// [IETF RFC 5771]: https://tools.ietf.org/html/rfc5771
696 /// [`true`]: ../../std/primitive.bool.html
701 /// use std::net::Ipv4Addr;
703 /// assert_eq!(Ipv4Addr::new(224, 254, 0, 0).is_multicast(), true);
704 /// assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_multicast(), true);
705 /// assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_multicast(), false);
707 #[stable(since = "1.7.0", feature = "ip_17")]
708 pub fn is_multicast(&self) -> bool {
709 self.octets()[0] >= 224 && self.octets()[0] <= 239
712 /// Returns [`true`] if this is a broadcast address (255.255.255.255).
714 /// A broadcast address has all octets set to 255 as defined in [IETF RFC 919].
716 /// [IETF RFC 919]: https://tools.ietf.org/html/rfc919
717 /// [`true`]: ../../std/primitive.bool.html
722 /// use std::net::Ipv4Addr;
724 /// assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_broadcast(), true);
725 /// assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_broadcast(), false);
727 #[stable(since = "1.7.0", feature = "ip_17")]
728 pub fn is_broadcast(&self) -> bool {
729 self == &Self::BROADCAST
732 /// Returns [`true`] if this address is in a range designated for documentation.
734 /// This is defined in [IETF RFC 5737]:
736 /// - 192.0.2.0/24 (TEST-NET-1)
737 /// - 198.51.100.0/24 (TEST-NET-2)
738 /// - 203.0.113.0/24 (TEST-NET-3)
740 /// [IETF RFC 5737]: https://tools.ietf.org/html/rfc5737
741 /// [`true`]: ../../std/primitive.bool.html
746 /// use std::net::Ipv4Addr;
748 /// assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_documentation(), true);
749 /// assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_documentation(), true);
750 /// assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_documentation(), true);
751 /// assert_eq!(Ipv4Addr::new(193, 34, 17, 19).is_documentation(), false);
753 #[stable(since = "1.7.0", feature = "ip_17")]
754 pub fn is_documentation(&self) -> bool {
755 match self.octets() {
756 [192, 0, 2, _] => true,
757 [198, 51, 100, _] => true,
758 [203, 0, 113, _] => true,
763 /// Converts this address to an IPv4-compatible [IPv6 address].
765 /// a.b.c.d becomes ::a.b.c.d
767 /// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
772 /// use std::net::{Ipv4Addr, Ipv6Addr};
775 /// Ipv4Addr::new(192, 0, 2, 255).to_ipv6_compatible(),
776 /// Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 767)
779 #[stable(feature = "rust1", since = "1.0.0")]
780 pub fn to_ipv6_compatible(&self) -> Ipv6Addr {
781 let octets = self.octets();
783 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, octets[0], octets[1], octets[2], octets[3],
787 /// Converts this address to an IPv4-mapped [IPv6 address].
789 /// a.b.c.d becomes ::ffff:a.b.c.d
791 /// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
796 /// use std::net::{Ipv4Addr, Ipv6Addr};
798 /// assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_mapped(),
799 /// Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 49152, 767));
801 #[stable(feature = "rust1", since = "1.0.0")]
802 pub fn to_ipv6_mapped(&self) -> Ipv6Addr {
803 let octets = self.octets();
805 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF, octets[0], octets[1], octets[2], octets[3],
810 #[stable(feature = "ip_addr", since = "1.7.0")]
811 impl fmt::Display for IpAddr {
812 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
814 IpAddr::V4(ip) => ip.fmt(fmt),
815 IpAddr::V6(ip) => ip.fmt(fmt),
820 #[stable(feature = "ip_from_ip", since = "1.16.0")]
821 impl From<Ipv4Addr> for IpAddr {
822 fn from(ipv4: Ipv4Addr) -> IpAddr {
827 #[stable(feature = "ip_from_ip", since = "1.16.0")]
828 impl From<Ipv6Addr> for IpAddr {
829 fn from(ipv6: Ipv6Addr) -> IpAddr {
834 #[stable(feature = "rust1", since = "1.0.0")]
835 impl fmt::Display for Ipv4Addr {
836 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
837 const IPV4_BUF_LEN: usize = 15; // Long enough for the longest possible IPv4 address
838 let mut buf = [0u8; IPV4_BUF_LEN];
839 let mut buf_slice = &mut buf[..];
840 let octets = self.octets();
841 // Note: The call to write should never fail, hence the unwrap
842 write!(buf_slice, "{}.{}.{}.{}", octets[0], octets[1], octets[2], octets[3]).unwrap();
843 let len = IPV4_BUF_LEN - buf_slice.len();
844 // This unsafe is OK because we know what is being written to the buffer
845 let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
850 #[stable(feature = "rust1", since = "1.0.0")]
851 impl fmt::Debug for Ipv4Addr {
852 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
853 fmt::Display::fmt(self, fmt)
857 #[stable(feature = "rust1", since = "1.0.0")]
858 impl Clone for Ipv4Addr {
859 fn clone(&self) -> Ipv4Addr {
864 #[stable(feature = "rust1", since = "1.0.0")]
865 impl PartialEq for Ipv4Addr {
866 fn eq(&self, other: &Ipv4Addr) -> bool {
867 self.inner.s_addr == other.inner.s_addr
871 #[stable(feature = "ip_cmp", since = "1.16.0")]
872 impl PartialEq<Ipv4Addr> for IpAddr {
873 fn eq(&self, other: &Ipv4Addr) -> bool {
875 IpAddr::V4(v4) => v4 == other,
876 IpAddr::V6(_) => false,
881 #[stable(feature = "ip_cmp", since = "1.16.0")]
882 impl PartialEq<IpAddr> for Ipv4Addr {
883 fn eq(&self, other: &IpAddr) -> bool {
885 IpAddr::V4(v4) => self == v4,
886 IpAddr::V6(_) => false,
891 #[stable(feature = "rust1", since = "1.0.0")]
892 impl Eq for Ipv4Addr {}
894 #[stable(feature = "rust1", since = "1.0.0")]
895 impl hash::Hash for Ipv4Addr {
896 fn hash<H: hash::Hasher>(&self, s: &mut H) {
897 // `inner` is #[repr(packed)], so we need to copy `s_addr`.
898 { self.inner.s_addr }.hash(s)
902 #[stable(feature = "rust1", since = "1.0.0")]
903 impl PartialOrd for Ipv4Addr {
904 fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
905 Some(self.cmp(other))
909 #[stable(feature = "ip_cmp", since = "1.16.0")]
910 impl PartialOrd<Ipv4Addr> for IpAddr {
911 fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
913 IpAddr::V4(v4) => v4.partial_cmp(other),
914 IpAddr::V6(_) => Some(Ordering::Greater),
919 #[stable(feature = "ip_cmp", since = "1.16.0")]
920 impl PartialOrd<IpAddr> for Ipv4Addr {
921 fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
923 IpAddr::V4(v4) => self.partial_cmp(v4),
924 IpAddr::V6(_) => Some(Ordering::Less),
929 #[stable(feature = "rust1", since = "1.0.0")]
930 impl Ord for Ipv4Addr {
931 fn cmp(&self, other: &Ipv4Addr) -> Ordering {
932 u32::from_be(self.inner.s_addr).cmp(&u32::from_be(other.inner.s_addr))
936 impl AsInner<c::in_addr> for Ipv4Addr {
937 fn as_inner(&self) -> &c::in_addr {
941 impl FromInner<c::in_addr> for Ipv4Addr {
942 fn from_inner(addr: c::in_addr) -> Ipv4Addr {
943 Ipv4Addr { inner: addr }
947 #[stable(feature = "ip_u32", since = "1.1.0")]
948 impl From<Ipv4Addr> for u32 {
949 /// Converts an `Ipv4Addr` into a host byte order `u32`.
954 /// use std::net::Ipv4Addr;
956 /// let addr = Ipv4Addr::new(13, 12, 11, 10);
957 /// assert_eq!(0x0d0c0b0au32, u32::from(addr));
959 fn from(ip: Ipv4Addr) -> u32 {
960 let ip = ip.octets();
961 u32::from_be_bytes(ip)
965 #[stable(feature = "ip_u32", since = "1.1.0")]
966 impl From<u32> for Ipv4Addr {
967 /// Converts a host byte order `u32` into an `Ipv4Addr`.
972 /// use std::net::Ipv4Addr;
974 /// let addr = Ipv4Addr::from(0x0d0c0b0au32);
975 /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
977 fn from(ip: u32) -> Ipv4Addr {
978 Ipv4Addr::from(ip.to_be_bytes())
982 #[stable(feature = "from_slice_v4", since = "1.9.0")]
983 impl From<[u8; 4]> for Ipv4Addr {
987 /// use std::net::Ipv4Addr;
989 /// let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]);
990 /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
992 fn from(octets: [u8; 4]) -> Ipv4Addr {
993 Ipv4Addr::new(octets[0], octets[1], octets[2], octets[3])
997 #[stable(feature = "ip_from_slice", since = "1.17.0")]
998 impl From<[u8; 4]> for IpAddr {
999 /// Creates an `IpAddr::V4` from a four element byte array.
1004 /// use std::net::{IpAddr, Ipv4Addr};
1006 /// let addr = IpAddr::from([13u8, 12u8, 11u8, 10u8]);
1007 /// assert_eq!(IpAddr::V4(Ipv4Addr::new(13, 12, 11, 10)), addr);
1009 fn from(octets: [u8; 4]) -> IpAddr {
1010 IpAddr::V4(Ipv4Addr::from(octets))
1015 /// Creates a new IPv6 address from eight 16-bit segments.
1017 /// The result will represent the IP address `a:b:c:d:e:f:g:h`.
1022 /// use std::net::Ipv6Addr;
1024 /// let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);
1026 #[stable(feature = "rust1", since = "1.0.0")]
1027 #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1028 pub const fn new(a: u16, b: u16, c: u16, d: u16, e: u16, f: u16, g: u16, h: u16) -> Ipv6Addr {
1030 inner: c::in6_addr {
1053 /// An IPv6 address representing localhost: `::1`.
1058 /// use std::net::Ipv6Addr;
1060 /// let addr = Ipv6Addr::LOCALHOST;
1061 /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
1063 #[stable(feature = "ip_constructors", since = "1.30.0")]
1064 pub const LOCALHOST: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
1066 /// An IPv6 address representing the unspecified address: `::`
1071 /// use std::net::Ipv6Addr;
1073 /// let addr = Ipv6Addr::UNSPECIFIED;
1074 /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
1076 #[stable(feature = "ip_constructors", since = "1.30.0")]
1077 pub const UNSPECIFIED: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0);
1079 /// Returns the eight 16-bit segments that make up this address.
1084 /// use std::net::Ipv6Addr;
1086 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).segments(),
1087 /// [0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff]);
1089 #[stable(feature = "rust1", since = "1.0.0")]
1090 pub fn segments(&self) -> [u16; 8] {
1091 let arr = &self.inner.s6_addr;
1093 u16::from_be_bytes([arr[0], arr[1]]),
1094 u16::from_be_bytes([arr[2], arr[3]]),
1095 u16::from_be_bytes([arr[4], arr[5]]),
1096 u16::from_be_bytes([arr[6], arr[7]]),
1097 u16::from_be_bytes([arr[8], arr[9]]),
1098 u16::from_be_bytes([arr[10], arr[11]]),
1099 u16::from_be_bytes([arr[12], arr[13]]),
1100 u16::from_be_bytes([arr[14], arr[15]]),
1104 /// Returns [`true`] for the special 'unspecified' address (::).
1106 /// This property is defined in [IETF RFC 4291].
1108 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1109 /// [`true`]: ../../std/primitive.bool.html
1114 /// use std::net::Ipv6Addr;
1116 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false);
1117 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);
1119 #[stable(since = "1.7.0", feature = "ip_17")]
1120 pub fn is_unspecified(&self) -> bool {
1121 self.segments() == [0, 0, 0, 0, 0, 0, 0, 0]
1124 /// Returns [`true`] if this is a loopback address (::1).
1126 /// This property is defined in [IETF RFC 4291].
1128 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1129 /// [`true`]: ../../std/primitive.bool.html
1134 /// use std::net::Ipv6Addr;
1136 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false);
1137 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);
1139 #[stable(since = "1.7.0", feature = "ip_17")]
1140 pub fn is_loopback(&self) -> bool {
1141 self.segments() == [0, 0, 0, 0, 0, 0, 0, 1]
1144 /// Returns [`true`] if the address appears to be globally routable.
1146 /// The following return [`false`]:
1148 /// - the loopback address
1149 /// - link-local and unique local unicast addresses
1150 /// - interface-, link-, realm-, admin- and site-local multicast addresses
1152 /// [`true`]: ../../std/primitive.bool.html
1153 /// [`false`]: ../../std/primitive.bool.html
1160 /// use std::net::Ipv6Addr;
1162 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true);
1163 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false);
1164 /// assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true);
1166 pub fn is_global(&self) -> bool {
1167 match self.multicast_scope() {
1168 Some(Ipv6MulticastScope::Global) => true,
1169 None => self.is_unicast_global(),
1174 /// Returns [`true`] if this is a unique local address (`fc00::/7`).
1176 /// This property is defined in [IETF RFC 4193].
1178 /// [IETF RFC 4193]: https://tools.ietf.org/html/rfc4193
1179 /// [`true`]: ../../std/primitive.bool.html
1186 /// use std::net::Ipv6Addr;
1188 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false);
1189 /// assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true);
1191 pub fn is_unique_local(&self) -> bool {
1192 (self.segments()[0] & 0xfe00) == 0xfc00
1195 /// Returns [`true`] if the address is a unicast link-local address (`fe80::/64`).
1197 /// A common mis-conception is to think that "unicast link-local addresses start with
1198 /// `fe80::`", but the [IETF RFC 4291] actually defines a stricter format for these addresses:
1202 /// | bits | 54 bits | 64 bits |
1203 /// +----------+-------------------------+----------------------------+
1204 /// |1111111010| 0 | interface ID |
1205 /// +----------+-------------------------+----------------------------+
1208 /// This method validates the format defined in the RFC and won't recognize the following
1209 /// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
1210 /// If you need a less strict validation use [`is_unicast_link_local()`] instead.
1217 /// use std::net::Ipv6Addr;
1219 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1220 /// assert!(ip.is_unicast_link_local_strict());
1222 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1223 /// assert!(ip.is_unicast_link_local_strict());
1225 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1226 /// assert!(!ip.is_unicast_link_local_strict());
1227 /// assert!(ip.is_unicast_link_local());
1229 /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1230 /// assert!(!ip.is_unicast_link_local_strict());
1231 /// assert!(ip.is_unicast_link_local());
1236 /// - [IETF RFC 4291 section 2.5.6]
1237 /// - [RFC 4291 errata 4406]
1238 /// - [`is_unicast_link_local()`]
1240 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1241 /// [IETF RFC 4291 section 2.5.6]: https://tools.ietf.org/html/rfc4291#section-2.5.6
1242 /// [`true`]: ../../std/primitive.bool.html
1243 /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1244 /// [`is_unicast_link_local()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local
1246 pub fn is_unicast_link_local_strict(&self) -> bool {
1247 (self.segments()[0] & 0xffff) == 0xfe80
1248 && (self.segments()[1] & 0xffff) == 0
1249 && (self.segments()[2] & 0xffff) == 0
1250 && (self.segments()[3] & 0xffff) == 0
1253 /// Returns [`true`] if the address is a unicast link-local address (`fe80::/10`).
1255 /// This method returns [`true`] for addresses in the range reserved by [RFC 4291 section 2.4],
1256 /// i.e. addresses with the following format:
1260 /// | bits | 54 bits | 64 bits |
1261 /// +----------+-------------------------+----------------------------+
1262 /// |1111111010| arbitratry value | interface ID |
1263 /// +----------+-------------------------+----------------------------+
1266 /// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
1267 /// unicast link-local addresses, whereas [`is_unicast_link_local_strict()`] does not. If you
1268 /// need a strict validation fully compliant with the RFC, use
1269 /// [`is_unicast_link_local_strict()`].
1276 /// use std::net::Ipv6Addr;
1278 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1279 /// assert!(ip.is_unicast_link_local());
1281 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1282 /// assert!(ip.is_unicast_link_local());
1284 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1285 /// assert!(ip.is_unicast_link_local());
1286 /// assert!(!ip.is_unicast_link_local_strict());
1288 /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1289 /// assert!(ip.is_unicast_link_local());
1290 /// assert!(!ip.is_unicast_link_local_strict());
1295 /// - [IETF RFC 4291 section 2.4]
1296 /// - [RFC 4291 errata 4406]
1298 /// [IETF RFC 4291 section 2.4]: https://tools.ietf.org/html/rfc4291#section-2.4
1299 /// [`true`]: ../../std/primitive.bool.html
1300 /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1301 /// [`is_unicast_link_local_strict()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local_strict
1303 pub fn is_unicast_link_local(&self) -> bool {
1304 (self.segments()[0] & 0xffc0) == 0xfe80
1307 /// Returns [`true`] if this is a deprecated unicast site-local address (fec0::/10). The
1308 /// unicast site-local address format is defined in [RFC 4291 section 2.5.7] as:
1312 /// | bits | 54 bits | 64 bits |
1313 /// +----------+-------------------------+----------------------------+
1314 /// |1111111011| subnet ID | interface ID |
1315 /// +----------+-------------------------+----------------------------+
1318 /// [`true`]: ../../std/primitive.bool.html
1319 /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1326 /// use std::net::Ipv6Addr;
1329 /// Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_site_local(),
1332 /// assert_eq!(Ipv6Addr::new(0xfec2, 0, 0, 0, 0, 0, 0, 0).is_unicast_site_local(), true);
1337 /// As per [RFC 3879], the whole `FEC0::/10` prefix is
1338 /// deprecated. New software must not support site-local
1341 /// [RFC 3879]: https://tools.ietf.org/html/rfc3879
1342 pub fn is_unicast_site_local(&self) -> bool {
1343 (self.segments()[0] & 0xffc0) == 0xfec0
1346 /// Returns [`true`] if this is an address reserved for documentation
1347 /// (2001:db8::/32).
1349 /// This property is defined in [IETF RFC 3849].
1351 /// [IETF RFC 3849]: https://tools.ietf.org/html/rfc3849
1352 /// [`true`]: ../../std/primitive.bool.html
1359 /// use std::net::Ipv6Addr;
1361 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false);
1362 /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true);
1364 pub fn is_documentation(&self) -> bool {
1365 (self.segments()[0] == 0x2001) && (self.segments()[1] == 0xdb8)
1368 /// Returns [`true`] if the address is a globally routable unicast address.
1370 /// The following return false:
1372 /// - the loopback address
1373 /// - the link-local addresses
1374 /// - unique local addresses
1375 /// - the unspecified address
1376 /// - the address range reserved for documentation
1378 /// This method returns [`true`] for site-local addresses as per [RFC 4291 section 2.5.7]
1381 /// The special behavior of [the site-local unicast] prefix defined in [RFC3513] must no longer
1382 /// be supported in new implementations (i.e., new implementations must treat this prefix as
1383 /// Global Unicast).
1386 /// [`true`]: ../../std/primitive.bool.html
1387 /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1394 /// use std::net::Ipv6Addr;
1396 /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false);
1397 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true);
1399 pub fn is_unicast_global(&self) -> bool {
1400 !self.is_multicast()
1401 && !self.is_loopback()
1402 && !self.is_unicast_link_local()
1403 && !self.is_unique_local()
1404 && !self.is_unspecified()
1405 && !self.is_documentation()
1408 /// Returns the address's multicast scope if the address is multicast.
1415 /// use std::net::{Ipv6Addr, Ipv6MulticastScope};
1418 /// Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(),
1419 /// Some(Ipv6MulticastScope::Global)
1421 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None);
1423 pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope> {
1424 if self.is_multicast() {
1425 match self.segments()[0] & 0x000f {
1426 1 => Some(Ipv6MulticastScope::InterfaceLocal),
1427 2 => Some(Ipv6MulticastScope::LinkLocal),
1428 3 => Some(Ipv6MulticastScope::RealmLocal),
1429 4 => Some(Ipv6MulticastScope::AdminLocal),
1430 5 => Some(Ipv6MulticastScope::SiteLocal),
1431 8 => Some(Ipv6MulticastScope::OrganizationLocal),
1432 14 => Some(Ipv6MulticastScope::Global),
1440 /// Returns [`true`] if this is a multicast address (ff00::/8).
1442 /// This property is defined by [IETF RFC 4291].
1444 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1445 /// [`true`]: ../../std/primitive.bool.html
1450 /// use std::net::Ipv6Addr;
1452 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true);
1453 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);
1455 #[stable(since = "1.7.0", feature = "ip_17")]
1456 pub fn is_multicast(&self) -> bool {
1457 (self.segments()[0] & 0xff00) == 0xff00
1460 /// Converts this address to an [IPv4 address]. Returns [`None`] if this address is
1461 /// neither IPv4-compatible or IPv4-mapped.
1463 /// ::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d
1465 /// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
1466 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1471 /// use std::net::{Ipv4Addr, Ipv6Addr};
1473 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None);
1474 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(),
1475 /// Some(Ipv4Addr::new(192, 10, 2, 255)));
1476 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(),
1477 /// Some(Ipv4Addr::new(0, 0, 0, 1)));
1479 #[stable(feature = "rust1", since = "1.0.0")]
1480 pub fn to_ipv4(&self) -> Option<Ipv4Addr> {
1481 match self.segments() {
1482 [0, 0, 0, 0, 0, f, g, h] if f == 0 || f == 0xffff => {
1483 Some(Ipv4Addr::new((g >> 8) as u8, g as u8, (h >> 8) as u8, h as u8))
1489 /// Returns the sixteen eight-bit integers the IPv6 address consists of.
1492 /// use std::net::Ipv6Addr;
1494 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).octets(),
1495 /// [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
1497 #[stable(feature = "ipv6_to_octets", since = "1.12.0")]
1498 #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1499 pub const fn octets(&self) -> [u8; 16] {
1504 #[stable(feature = "rust1", since = "1.0.0")]
1505 impl fmt::Display for Ipv6Addr {
1506 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1507 // Note: The calls to write should never fail, hence the unwraps in the function
1508 // Long enough for the longest possible IPv6: 39
1509 const IPV6_BUF_LEN: usize = 39;
1510 let mut buf = [0u8; IPV6_BUF_LEN];
1511 let mut buf_slice = &mut buf[..];
1513 match self.segments() {
1514 // We need special cases for :: and ::1, otherwise they're formatted
1516 [0, 0, 0, 0, 0, 0, 0, 0] => write!(buf_slice, "::").unwrap(),
1517 [0, 0, 0, 0, 0, 0, 0, 1] => write!(buf_slice, "::1").unwrap(),
1518 // Ipv4 Compatible address
1519 [0, 0, 0, 0, 0, 0, g, h] => {
1530 // Ipv4-Mapped address
1531 [0, 0, 0, 0, 0, 0xffff, g, h] => {
1534 "::ffff:{}.{}.{}.{}",
1543 fn find_zero_slice(segments: &[u16; 8]) -> (usize, usize) {
1544 let mut longest_span_len = 0;
1545 let mut longest_span_at = 0;
1546 let mut cur_span_len = 0;
1547 let mut cur_span_at = 0;
1550 if segments[i] == 0 {
1551 if cur_span_len == 0 {
1557 if cur_span_len > longest_span_len {
1558 longest_span_len = cur_span_len;
1559 longest_span_at = cur_span_at;
1567 (longest_span_at, longest_span_len)
1570 let (zeros_at, zeros_len) = find_zero_slice(&self.segments());
1573 fn fmt_subslice(segments: &[u16], buf: &mut &mut [u8]) {
1574 if !segments.is_empty() {
1575 write!(*buf, "{:x}", segments[0]).unwrap();
1576 for &seg in &segments[1..] {
1577 write!(*buf, ":{:x}", seg).unwrap();
1582 fmt_subslice(&self.segments()[..zeros_at], &mut buf_slice);
1583 write!(buf_slice, "::").unwrap();
1584 fmt_subslice(&self.segments()[zeros_at + zeros_len..], &mut buf_slice);
1586 let &[a, b, c, d, e, f, g, h] = &self.segments();
1589 "{:x}:{:x}:{:x}:{:x}:{:x}:{:x}:{:x}:{:x}",
1590 a, b, c, d, e, f, g, h
1596 let len = IPV6_BUF_LEN - buf_slice.len();
1597 // This is safe because we know exactly what can be in this buffer
1598 let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
1603 #[stable(feature = "rust1", since = "1.0.0")]
1604 impl fmt::Debug for Ipv6Addr {
1605 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1606 fmt::Display::fmt(self, fmt)
1610 #[stable(feature = "rust1", since = "1.0.0")]
1611 impl Clone for Ipv6Addr {
1612 fn clone(&self) -> Ipv6Addr {
1617 #[stable(feature = "rust1", since = "1.0.0")]
1618 impl PartialEq for Ipv6Addr {
1619 fn eq(&self, other: &Ipv6Addr) -> bool {
1620 self.inner.s6_addr == other.inner.s6_addr
1624 #[stable(feature = "ip_cmp", since = "1.16.0")]
1625 impl PartialEq<IpAddr> for Ipv6Addr {
1626 fn eq(&self, other: &IpAddr) -> bool {
1628 IpAddr::V4(_) => false,
1629 IpAddr::V6(v6) => self == v6,
1634 #[stable(feature = "ip_cmp", since = "1.16.0")]
1635 impl PartialEq<Ipv6Addr> for IpAddr {
1636 fn eq(&self, other: &Ipv6Addr) -> bool {
1638 IpAddr::V4(_) => false,
1639 IpAddr::V6(v6) => v6 == other,
1644 #[stable(feature = "rust1", since = "1.0.0")]
1645 impl Eq for Ipv6Addr {}
1647 #[stable(feature = "rust1", since = "1.0.0")]
1648 impl hash::Hash for Ipv6Addr {
1649 fn hash<H: hash::Hasher>(&self, s: &mut H) {
1650 self.inner.s6_addr.hash(s)
1654 #[stable(feature = "rust1", since = "1.0.0")]
1655 impl PartialOrd for Ipv6Addr {
1656 fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1657 Some(self.cmp(other))
1661 #[stable(feature = "ip_cmp", since = "1.16.0")]
1662 impl PartialOrd<Ipv6Addr> for IpAddr {
1663 fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1665 IpAddr::V4(_) => Some(Ordering::Less),
1666 IpAddr::V6(v6) => v6.partial_cmp(other),
1671 #[stable(feature = "ip_cmp", since = "1.16.0")]
1672 impl PartialOrd<IpAddr> for Ipv6Addr {
1673 fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
1675 IpAddr::V4(_) => Some(Ordering::Greater),
1676 IpAddr::V6(v6) => self.partial_cmp(v6),
1681 #[stable(feature = "rust1", since = "1.0.0")]
1682 impl Ord for Ipv6Addr {
1683 fn cmp(&self, other: &Ipv6Addr) -> Ordering {
1684 self.segments().cmp(&other.segments())
1688 impl AsInner<c::in6_addr> for Ipv6Addr {
1689 fn as_inner(&self) -> &c::in6_addr {
1693 impl FromInner<c::in6_addr> for Ipv6Addr {
1694 fn from_inner(addr: c::in6_addr) -> Ipv6Addr {
1695 Ipv6Addr { inner: addr }
1699 #[stable(feature = "i128", since = "1.26.0")]
1700 impl From<Ipv6Addr> for u128 {
1701 /// Convert an `Ipv6Addr` into a host byte order `u128`.
1706 /// use std::net::Ipv6Addr;
1708 /// let addr = Ipv6Addr::new(
1709 /// 0x1020, 0x3040, 0x5060, 0x7080,
1710 /// 0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1712 /// assert_eq!(0x102030405060708090A0B0C0D0E0F00D_u128, u128::from(addr));
1714 fn from(ip: Ipv6Addr) -> u128 {
1715 let ip = ip.octets();
1716 u128::from_be_bytes(ip)
1719 #[stable(feature = "i128", since = "1.26.0")]
1720 impl From<u128> for Ipv6Addr {
1721 /// Convert a host byte order `u128` into an `Ipv6Addr`.
1726 /// use std::net::Ipv6Addr;
1728 /// let addr = Ipv6Addr::from(0x102030405060708090A0B0C0D0E0F00D_u128);
1731 /// 0x1020, 0x3040, 0x5060, 0x7080,
1732 /// 0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1736 fn from(ip: u128) -> Ipv6Addr {
1737 Ipv6Addr::from(ip.to_be_bytes())
1741 #[stable(feature = "ipv6_from_octets", since = "1.9.0")]
1742 impl From<[u8; 16]> for Ipv6Addr {
1743 fn from(octets: [u8; 16]) -> Ipv6Addr {
1744 let inner = c::in6_addr { s6_addr: octets };
1745 Ipv6Addr::from_inner(inner)
1749 #[stable(feature = "ipv6_from_segments", since = "1.16.0")]
1750 impl From<[u16; 8]> for Ipv6Addr {
1751 fn from(segments: [u16; 8]) -> Ipv6Addr {
1752 let [a, b, c, d, e, f, g, h] = segments;
1753 Ipv6Addr::new(a, b, c, d, e, f, g, h)
1757 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1758 impl From<[u8; 16]> for IpAddr {
1759 /// Creates an `IpAddr::V6` from a sixteen element byte array.
1764 /// use std::net::{IpAddr, Ipv6Addr};
1766 /// let addr = IpAddr::from([
1767 /// 25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
1768 /// 17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
1771 /// IpAddr::V6(Ipv6Addr::new(
1780 fn from(octets: [u8; 16]) -> IpAddr {
1781 IpAddr::V6(Ipv6Addr::from(octets))
1785 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1786 impl From<[u16; 8]> for IpAddr {
1787 /// Creates an `IpAddr::V6` from an eight element 16-bit array.
1792 /// use std::net::{IpAddr, Ipv6Addr};
1794 /// let addr = IpAddr::from([
1795 /// 525u16, 524u16, 523u16, 522u16,
1796 /// 521u16, 520u16, 519u16, 518u16,
1799 /// IpAddr::V6(Ipv6Addr::new(
1808 fn from(segments: [u16; 8]) -> IpAddr {
1809 IpAddr::V6(Ipv6Addr::from(segments))
1813 // Tests for this module
1814 #[cfg(all(test, not(target_os = "emscripten")))]
1816 use crate::net::test::{sa4, sa6, tsa};
1818 use crate::str::FromStr;
1821 fn test_from_str_ipv4() {
1822 assert_eq!(Ok(Ipv4Addr::new(127, 0, 0, 1)), "127.0.0.1".parse());
1823 assert_eq!(Ok(Ipv4Addr::new(255, 255, 255, 255)), "255.255.255.255".parse());
1824 assert_eq!(Ok(Ipv4Addr::new(0, 0, 0, 0)), "0.0.0.0".parse());
1827 let none: Option<Ipv4Addr> = "256.0.0.1".parse().ok();
1828 assert_eq!(None, none);
1830 let none: Option<Ipv4Addr> = "255.0.0".parse().ok();
1831 assert_eq!(None, none);
1833 let none: Option<Ipv4Addr> = "255.0.0.1.2".parse().ok();
1834 assert_eq!(None, none);
1835 // no number between dots
1836 let none: Option<Ipv4Addr> = "255.0..1".parse().ok();
1837 assert_eq!(None, none);
1841 fn test_from_str_ipv6() {
1842 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "0:0:0:0:0:0:0:0".parse());
1843 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "0:0:0:0:0:0:0:1".parse());
1845 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "::1".parse());
1846 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "::".parse());
1849 Ok(Ipv6Addr::new(0x2a02, 0x6b8, 0, 0, 0, 0, 0x11, 0x11)),
1850 "2a02:6b8::11:11".parse()
1854 let none: Option<Ipv6Addr> = "::00000".parse().ok();
1855 assert_eq!(None, none);
1857 let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7".parse().ok();
1858 assert_eq!(None, none);
1860 let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7:8:9".parse().ok();
1861 assert_eq!(None, none);
1863 let none: Option<Ipv6Addr> = "1:2:::6:7:8".parse().ok();
1864 assert_eq!(None, none);
1865 // two double colons
1866 let none: Option<Ipv6Addr> = "1:2::6::8".parse().ok();
1867 assert_eq!(None, none);
1868 // `::` indicating zero groups of zeros
1869 let none: Option<Ipv6Addr> = "1:2:3:4::5:6:7:8".parse().ok();
1870 assert_eq!(None, none);
1874 fn test_from_str_ipv4_in_ipv6() {
1875 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 545)), "::192.0.2.33".parse());
1877 Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0xFFFF, 49152, 545)),
1878 "::FFFF:192.0.2.33".parse()
1881 Ok(Ipv6Addr::new(0x64, 0xff9b, 0, 0, 0, 0, 49152, 545)),
1882 "64:ff9b::192.0.2.33".parse()
1885 Ok(Ipv6Addr::new(0x2001, 0xdb8, 0x122, 0xc000, 0x2, 0x2100, 49152, 545)),
1886 "2001:db8:122:c000:2:2100:192.0.2.33".parse()
1890 let none: Option<Ipv4Addr> = "::127.0.0.1:".parse().ok();
1891 assert_eq!(None, none);
1892 // not enough groups
1893 let none: Option<Ipv6Addr> = "1.2.3.4.5:127.0.0.1".parse().ok();
1894 assert_eq!(None, none);
1896 let none: Option<Ipv6Addr> = "1.2.3.4.5:6:7:127.0.0.1".parse().ok();
1897 assert_eq!(None, none);
1901 fn test_from_str_socket_addr() {
1902 assert_eq!(Ok(sa4(Ipv4Addr::new(77, 88, 21, 11), 80)), "77.88.21.11:80".parse());
1904 Ok(SocketAddrV4::new(Ipv4Addr::new(77, 88, 21, 11), 80)),
1905 "77.88.21.11:80".parse()
1908 Ok(sa6(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53)),
1909 "[2a02:6b8:0:1::1]:53".parse()
1912 Ok(SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53, 0, 0)),
1913 "[2a02:6b8:0:1::1]:53".parse()
1916 Ok(sa6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22)),
1917 "[::127.0.0.1]:22".parse()
1920 Ok(SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22, 0, 0)),
1921 "[::127.0.0.1]:22".parse()
1925 let none: Option<SocketAddr> = "127.0.0.1".parse().ok();
1926 assert_eq!(None, none);
1928 let none: Option<SocketAddr> = "127.0.0.1:".parse().ok();
1929 assert_eq!(None, none);
1930 // wrong brackets around v4
1931 let none: Option<SocketAddr> = "[127.0.0.1]:22".parse().ok();
1932 assert_eq!(None, none);
1933 // port out of range
1934 let none: Option<SocketAddr> = "127.0.0.1:123456".parse().ok();
1935 assert_eq!(None, none);
1939 fn ipv4_addr_to_string() {
1941 assert_eq!(Ipv4Addr::new(1, 1, 1, 1).to_string(), "1.1.1.1");
1943 assert_eq!(Ipv4Addr::new(127, 127, 127, 127).to_string(), "127.127.127.127");
1946 assert_eq!(&format!("{:16}", Ipv4Addr::new(1, 1, 1, 1)), "1.1.1.1 ");
1947 assert_eq!(&format!("{:>16}", Ipv4Addr::new(1, 1, 1, 1)), " 1.1.1.1");
1951 fn ipv6_addr_to_string() {
1952 // ipv4-mapped address
1953 let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc000, 0x280);
1954 assert_eq!(a1.to_string(), "::ffff:192.0.2.128");
1956 // ipv4-compatible address
1957 let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0xc000, 0x280);
1958 assert_eq!(a1.to_string(), "::192.0.2.128");
1960 // v6 address with no zero segments
1961 assert_eq!(Ipv6Addr::new(8, 9, 10, 11, 12, 13, 14, 15).to_string(), "8:9:a:b:c:d:e:f");
1963 // longest possible IPv6 length
1965 Ipv6Addr::new(0x1111, 0x2222, 0x3333, 0x4444, 0x5555, 0x6666, 0x7777, 0x8888)
1967 "1111:2222:3333:4444:5555:6666:7777:8888"
1971 &format!("{:20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
1975 &format!("{:>20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
1979 // reduce a single run of zeros
1982 Ipv6Addr::new(0xae, 0, 0, 0, 0, 0xffff, 0x0102, 0x0304).to_string()
1985 // don't reduce just a single zero segment
1986 assert_eq!("1:2:3:4:5:6:0:8", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 0, 8).to_string());
1989 assert_eq!("::", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).to_string());
1992 assert_eq!("::1", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_string());
1995 assert_eq!("1::", Ipv6Addr::new(1, 0, 0, 0, 0, 0, 0, 0).to_string());
1997 // two runs of zeros, second one is longer
1998 assert_eq!("1:0:0:4::8", Ipv6Addr::new(1, 0, 0, 4, 0, 0, 0, 8).to_string());
2000 // two runs of zeros, equal length
2001 assert_eq!("1::4:5:0:0:8", Ipv6Addr::new(1, 0, 0, 4, 5, 0, 0, 8).to_string());
2007 Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678),
2008 Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_mapped()
2011 Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678),
2012 Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_compatible()
2019 Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678).to_ipv4(),
2020 Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2023 Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678).to_ipv4(),
2024 Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2026 assert_eq!(Ipv6Addr::new(0, 0, 1, 0, 0, 0, 0x1234, 0x5678).to_ipv4(), None);
2030 fn ip_properties() {
2033 IpAddr::from_str($s).unwrap()
2037 macro_rules! check {
2042 ($s:expr, $mask:expr) => {{
2043 let unspec: u8 = 1 << 0;
2044 let loopback: u8 = 1 << 1;
2045 let global: u8 = 1 << 2;
2046 let multicast: u8 = 1 << 3;
2047 let doc: u8 = 1 << 4;
2049 if ($mask & unspec) == unspec {
2050 assert!(ip!($s).is_unspecified());
2052 assert!(!ip!($s).is_unspecified());
2055 if ($mask & loopback) == loopback {
2056 assert!(ip!($s).is_loopback());
2058 assert!(!ip!($s).is_loopback());
2061 if ($mask & global) == global {
2062 assert!(ip!($s).is_global());
2064 assert!(!ip!($s).is_global());
2067 if ($mask & multicast) == multicast {
2068 assert!(ip!($s).is_multicast());
2070 assert!(!ip!($s).is_multicast());
2073 if ($mask & doc) == doc {
2074 assert!(ip!($s).is_documentation());
2076 assert!(!ip!($s).is_documentation());
2081 let unspec: u8 = 1 << 0;
2082 let loopback: u8 = 1 << 1;
2083 let global: u8 = 1 << 2;
2084 let multicast: u8 = 1 << 3;
2085 let doc: u8 = 1 << 4;
2087 check!("0.0.0.0", unspec);
2091 check!("127.1.2.3", loopback);
2092 check!("172.31.254.253");
2093 check!("169.254.253.242");
2094 check!("192.0.2.183", doc);
2095 check!("192.1.2.183", global);
2096 check!("192.168.254.253");
2097 check!("198.51.100.0", doc);
2098 check!("203.0.113.0", doc);
2099 check!("203.2.113.0", global);
2100 check!("224.0.0.0", global | multicast);
2101 check!("239.255.255.255", global | multicast);
2102 check!("255.255.255.255");
2103 // make sure benchmarking addresses are not global
2104 check!("198.18.0.0");
2105 check!("198.18.54.2");
2106 check!("198.19.255.255");
2107 // make sure addresses reserved for protocol assignment are not global
2108 check!("192.0.0.0");
2109 check!("192.0.0.255");
2110 check!("192.0.0.100");
2111 // make sure reserved addresses are not global
2112 check!("240.0.0.0");
2113 check!("251.54.1.76");
2114 check!("254.255.255.255");
2115 // make sure shared addresses are not global
2116 check!("100.64.0.0");
2117 check!("100.127.255.255");
2118 check!("100.100.100.0");
2120 check!("::", unspec);
2121 check!("::1", loopback);
2122 check!("::0.0.0.2", global);
2123 check!("1::", global);
2125 check!("fdff:ffff::");
2126 check!("fe80:ffff::");
2127 check!("febf:ffff::");
2128 check!("fec0::", global);
2129 check!("ff01::", multicast);
2130 check!("ff02::", multicast);
2131 check!("ff03::", multicast);
2132 check!("ff04::", multicast);
2133 check!("ff05::", multicast);
2134 check!("ff08::", multicast);
2135 check!("ff0e::", global | multicast);
2136 check!("2001:db8:85a3::8a2e:370:7334", doc);
2137 check!("102:304:506:708:90a:b0c:d0e:f10", global);
2141 fn ipv4_properties() {
2144 Ipv4Addr::from_str($s).unwrap()
2148 macro_rules! check {
2153 ($s:expr, $mask:expr) => {{
2154 let unspec: u16 = 1 << 0;
2155 let loopback: u16 = 1 << 1;
2156 let private: u16 = 1 << 2;
2157 let link_local: u16 = 1 << 3;
2158 let global: u16 = 1 << 4;
2159 let multicast: u16 = 1 << 5;
2160 let broadcast: u16 = 1 << 6;
2161 let documentation: u16 = 1 << 7;
2162 let benchmarking: u16 = 1 << 8;
2163 let ietf_protocol_assignment: u16 = 1 << 9;
2164 let reserved: u16 = 1 << 10;
2165 let shared: u16 = 1 << 11;
2167 if ($mask & unspec) == unspec {
2168 assert!(ip!($s).is_unspecified());
2170 assert!(!ip!($s).is_unspecified());
2173 if ($mask & loopback) == loopback {
2174 assert!(ip!($s).is_loopback());
2176 assert!(!ip!($s).is_loopback());
2179 if ($mask & private) == private {
2180 assert!(ip!($s).is_private());
2182 assert!(!ip!($s).is_private());
2185 if ($mask & link_local) == link_local {
2186 assert!(ip!($s).is_link_local());
2188 assert!(!ip!($s).is_link_local());
2191 if ($mask & global) == global {
2192 assert!(ip!($s).is_global());
2194 assert!(!ip!($s).is_global());
2197 if ($mask & multicast) == multicast {
2198 assert!(ip!($s).is_multicast());
2200 assert!(!ip!($s).is_multicast());
2203 if ($mask & broadcast) == broadcast {
2204 assert!(ip!($s).is_broadcast());
2206 assert!(!ip!($s).is_broadcast());
2209 if ($mask & documentation) == documentation {
2210 assert!(ip!($s).is_documentation());
2212 assert!(!ip!($s).is_documentation());
2215 if ($mask & benchmarking) == benchmarking {
2216 assert!(ip!($s).is_benchmarking());
2218 assert!(!ip!($s).is_benchmarking());
2221 if ($mask & ietf_protocol_assignment) == ietf_protocol_assignment {
2222 assert!(ip!($s).is_ietf_protocol_assignment());
2224 assert!(!ip!($s).is_ietf_protocol_assignment());
2227 if ($mask & reserved) == reserved {
2228 assert!(ip!($s).is_reserved());
2230 assert!(!ip!($s).is_reserved());
2233 if ($mask & shared) == shared {
2234 assert!(ip!($s).is_shared());
2236 assert!(!ip!($s).is_shared());
2241 let unspec: u16 = 1 << 0;
2242 let loopback: u16 = 1 << 1;
2243 let private: u16 = 1 << 2;
2244 let link_local: u16 = 1 << 3;
2245 let global: u16 = 1 << 4;
2246 let multicast: u16 = 1 << 5;
2247 let broadcast: u16 = 1 << 6;
2248 let documentation: u16 = 1 << 7;
2249 let benchmarking: u16 = 1 << 8;
2250 let ietf_protocol_assignment: u16 = 1 << 9;
2251 let reserved: u16 = 1 << 10;
2252 let shared: u16 = 1 << 11;
2254 check!("0.0.0.0", unspec);
2257 check!("10.9.8.7", private);
2258 check!("127.1.2.3", loopback);
2259 check!("172.31.254.253", private);
2260 check!("169.254.253.242", link_local);
2261 check!("192.0.2.183", documentation);
2262 check!("192.1.2.183", global);
2263 check!("192.168.254.253", private);
2264 check!("198.51.100.0", documentation);
2265 check!("203.0.113.0", documentation);
2266 check!("203.2.113.0", global);
2267 check!("224.0.0.0", global | multicast);
2268 check!("239.255.255.255", global | multicast);
2269 check!("255.255.255.255", broadcast);
2270 check!("198.18.0.0", benchmarking);
2271 check!("198.18.54.2", benchmarking);
2272 check!("198.19.255.255", benchmarking);
2273 check!("192.0.0.0", ietf_protocol_assignment);
2274 check!("192.0.0.255", ietf_protocol_assignment);
2275 check!("192.0.0.100", ietf_protocol_assignment);
2276 check!("240.0.0.0", reserved);
2277 check!("251.54.1.76", reserved);
2278 check!("254.255.255.255", reserved);
2279 check!("100.64.0.0", shared);
2280 check!("100.127.255.255", shared);
2281 check!("100.100.100.0", shared);
2285 fn ipv6_properties() {
2288 Ipv6Addr::from_str($s).unwrap()
2292 macro_rules! check {
2293 ($s:expr, &[$($octet:expr),*], $mask:expr) => {
2294 assert_eq!($s, ip!($s).to_string());
2295 let octets = &[$($octet),*];
2296 assert_eq!(&ip!($s).octets(), octets);
2297 assert_eq!(Ipv6Addr::from(*octets), ip!($s));
2299 let unspecified: u16 = 1 << 0;
2300 let loopback: u16 = 1 << 1;
2301 let unique_local: u16 = 1 << 2;
2302 let global: u16 = 1 << 3;
2303 let unicast_link_local: u16 = 1 << 4;
2304 let unicast_link_local_strict: u16 = 1 << 5;
2305 let unicast_site_local: u16 = 1 << 6;
2306 let unicast_global: u16 = 1 << 7;
2307 let documentation: u16 = 1 << 8;
2308 let multicast_interface_local: u16 = 1 << 9;
2309 let multicast_link_local: u16 = 1 << 10;
2310 let multicast_realm_local: u16 = 1 << 11;
2311 let multicast_admin_local: u16 = 1 << 12;
2312 let multicast_site_local: u16 = 1 << 13;
2313 let multicast_organization_local: u16 = 1 << 14;
2314 let multicast_global: u16 = 1 << 15;
2315 let multicast: u16 = multicast_interface_local
2316 | multicast_admin_local
2318 | multicast_link_local
2319 | multicast_realm_local
2320 | multicast_site_local
2321 | multicast_organization_local;
2323 if ($mask & unspecified) == unspecified {
2324 assert!(ip!($s).is_unspecified());
2326 assert!(!ip!($s).is_unspecified());
2328 if ($mask & loopback) == loopback {
2329 assert!(ip!($s).is_loopback());
2331 assert!(!ip!($s).is_loopback());
2333 if ($mask & unique_local) == unique_local {
2334 assert!(ip!($s).is_unique_local());
2336 assert!(!ip!($s).is_unique_local());
2338 if ($mask & global) == global {
2339 assert!(ip!($s).is_global());
2341 assert!(!ip!($s).is_global());
2343 if ($mask & unicast_link_local) == unicast_link_local {
2344 assert!(ip!($s).is_unicast_link_local());
2346 assert!(!ip!($s).is_unicast_link_local());
2348 if ($mask & unicast_link_local_strict) == unicast_link_local_strict {
2349 assert!(ip!($s).is_unicast_link_local_strict());
2351 assert!(!ip!($s).is_unicast_link_local_strict());
2353 if ($mask & unicast_site_local) == unicast_site_local {
2354 assert!(ip!($s).is_unicast_site_local());
2356 assert!(!ip!($s).is_unicast_site_local());
2358 if ($mask & unicast_global) == unicast_global {
2359 assert!(ip!($s).is_unicast_global());
2361 assert!(!ip!($s).is_unicast_global());
2363 if ($mask & documentation) == documentation {
2364 assert!(ip!($s).is_documentation());
2366 assert!(!ip!($s).is_documentation());
2368 if ($mask & multicast) != 0 {
2369 assert!(ip!($s).multicast_scope().is_some());
2370 assert!(ip!($s).is_multicast());
2372 assert!(ip!($s).multicast_scope().is_none());
2373 assert!(!ip!($s).is_multicast());
2375 if ($mask & multicast_interface_local) == multicast_interface_local {
2376 assert_eq!(ip!($s).multicast_scope().unwrap(),
2377 Ipv6MulticastScope::InterfaceLocal);
2379 if ($mask & multicast_link_local) == multicast_link_local {
2380 assert_eq!(ip!($s).multicast_scope().unwrap(),
2381 Ipv6MulticastScope::LinkLocal);
2383 if ($mask & multicast_realm_local) == multicast_realm_local {
2384 assert_eq!(ip!($s).multicast_scope().unwrap(),
2385 Ipv6MulticastScope::RealmLocal);
2387 if ($mask & multicast_admin_local) == multicast_admin_local {
2388 assert_eq!(ip!($s).multicast_scope().unwrap(),
2389 Ipv6MulticastScope::AdminLocal);
2391 if ($mask & multicast_site_local) == multicast_site_local {
2392 assert_eq!(ip!($s).multicast_scope().unwrap(),
2393 Ipv6MulticastScope::SiteLocal);
2395 if ($mask & multicast_organization_local) == multicast_organization_local {
2396 assert_eq!(ip!($s).multicast_scope().unwrap(),
2397 Ipv6MulticastScope::OrganizationLocal);
2399 if ($mask & multicast_global) == multicast_global {
2400 assert_eq!(ip!($s).multicast_scope().unwrap(),
2401 Ipv6MulticastScope::Global);
2406 let unspecified: u16 = 1 << 0;
2407 let loopback: u16 = 1 << 1;
2408 let unique_local: u16 = 1 << 2;
2409 let global: u16 = 1 << 3;
2410 let unicast_link_local: u16 = 1 << 4;
2411 let unicast_link_local_strict: u16 = 1 << 5;
2412 let unicast_site_local: u16 = 1 << 6;
2413 let unicast_global: u16 = 1 << 7;
2414 let documentation: u16 = 1 << 8;
2415 let multicast_interface_local: u16 = 1 << 9;
2416 let multicast_link_local: u16 = 1 << 10;
2417 let multicast_realm_local: u16 = 1 << 11;
2418 let multicast_admin_local: u16 = 1 << 12;
2419 let multicast_site_local: u16 = 1 << 13;
2420 let multicast_organization_local: u16 = 1 << 14;
2421 let multicast_global: u16 = 1 << 15;
2423 check!("::", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unspecified);
2425 check!("::1", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1], loopback);
2429 &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2],
2430 global | unicast_global
2433 check!("1::", &[0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], global | unicast_global);
2435 check!("fc00::", &[0xfc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unique_local);
2439 &[0xfd, 0xff, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2445 &[0xfe, 0x80, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2451 &[0xfe, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2452 unicast_link_local | unicast_link_local_strict
2457 &[0xfe, 0xbf, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2463 &[0xfe, 0xbf, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2468 "febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
2470 0xfe, 0xbf, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2477 "fe80::ffff:ffff:ffff:ffff",
2479 0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2482 unicast_link_local | unicast_link_local_strict
2487 &[0xfe, 0x80, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
2493 &[0xfe, 0xc0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2494 unicast_site_local | unicast_global | global
2499 &[0xff, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2500 multicast_interface_local
2505 &[0xff, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2506 multicast_link_local
2511 &[0xff, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2512 multicast_realm_local
2517 &[0xff, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2518 multicast_admin_local
2523 &[0xff, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2524 multicast_site_local
2529 &[0xff, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2530 multicast_organization_local
2535 &[0xff, 0xe, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2536 multicast_global | global
2540 "2001:db8:85a3::8a2e:370:7334",
2541 &[0x20, 1, 0xd, 0xb8, 0x85, 0xa3, 0, 0, 0, 0, 0x8a, 0x2e, 3, 0x70, 0x73, 0x34],
2546 "102:304:506:708:90a:b0c:d0e:f10",
2547 &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16],
2548 global | unicast_global
2553 fn to_socket_addr_socketaddr() {
2554 let a = sa4(Ipv4Addr::new(77, 88, 21, 11), 12345);
2555 assert_eq!(Ok(vec![a]), tsa(a));
2559 fn test_ipv4_to_int() {
2560 let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2561 assert_eq!(u32::from(a), 0x11223344);
2565 fn test_int_to_ipv4() {
2566 let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2567 assert_eq!(Ipv4Addr::from(0x11223344), a);
2571 fn test_ipv6_to_int() {
2572 let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2573 assert_eq!(u128::from(a), 0x112233445566778899aabbccddeeff11u128);
2577 fn test_int_to_ipv6() {
2578 let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2579 assert_eq!(Ipv6Addr::from(0x112233445566778899aabbccddeeff11u128), a);
2583 fn ipv4_from_constructors() {
2584 assert_eq!(Ipv4Addr::LOCALHOST, Ipv4Addr::new(127, 0, 0, 1));
2585 assert!(Ipv4Addr::LOCALHOST.is_loopback());
2586 assert_eq!(Ipv4Addr::UNSPECIFIED, Ipv4Addr::new(0, 0, 0, 0));
2587 assert!(Ipv4Addr::UNSPECIFIED.is_unspecified());
2588 assert_eq!(Ipv4Addr::BROADCAST, Ipv4Addr::new(255, 255, 255, 255));
2589 assert!(Ipv4Addr::BROADCAST.is_broadcast());
2593 fn ipv6_from_contructors() {
2594 assert_eq!(Ipv6Addr::LOCALHOST, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
2595 assert!(Ipv6Addr::LOCALHOST.is_loopback());
2596 assert_eq!(Ipv6Addr::UNSPECIFIED, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
2597 assert!(Ipv6Addr::UNSPECIFIED.is_unspecified());
2601 fn ipv4_from_octets() {
2602 assert_eq!(Ipv4Addr::from([127, 0, 0, 1]), Ipv4Addr::new(127, 0, 0, 1))
2606 fn ipv6_from_segments() {
2608 Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2609 let new = Ipv6Addr::new(0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff);
2610 assert_eq!(new, from_u16s);
2614 fn ipv6_from_octets() {
2616 Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2617 let from_u8s = Ipv6Addr::from([
2618 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd,
2621 assert_eq!(from_u16s, from_u8s);
2626 let v41 = Ipv4Addr::new(100, 64, 3, 3);
2627 let v42 = Ipv4Addr::new(192, 0, 2, 2);
2628 let v61 = "2001:db8:f00::1002".parse::<Ipv6Addr>().unwrap();
2629 let v62 = "2001:db8:f00::2001".parse::<Ipv6Addr>().unwrap();
2633 assert_eq!(v41, IpAddr::V4(v41));
2634 assert_eq!(v61, IpAddr::V6(v61));
2635 assert!(v41 != IpAddr::V4(v42));
2636 assert!(v61 != IpAddr::V6(v62));
2638 assert!(v41 < IpAddr::V4(v42));
2639 assert!(v61 < IpAddr::V6(v62));
2640 assert!(IpAddr::V4(v41) < v42);
2641 assert!(IpAddr::V6(v61) < v62);
2643 assert!(v41 < IpAddr::V6(v61));
2644 assert!(IpAddr::V4(v41) < v61);
2649 let ip = IpAddr::V4(Ipv4Addr::new(100, 64, 3, 3));
2650 assert!(ip.is_ipv4());
2651 assert!(!ip.is_ipv6());
2656 let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678));
2657 assert!(!ip.is_ipv4());
2658 assert!(ip.is_ipv6());