3 reason = "extra functionality has not been \
4 scrutinized to the level that it should \
9 use crate::cmp::Ordering;
10 use crate::fmt::{self, Write as FmtWrite};
12 use crate::io::Write as IoWrite;
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 explicitly 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 /// Copies this address to a new `IpAddr::V4`.
821 /// use std::net::{IpAddr, Ipv4Addr};
823 /// let addr = Ipv4Addr::new(127, 0, 0, 1);
826 /// IpAddr::V4(addr),
827 /// IpAddr::from(addr)
830 fn from(ipv4: Ipv4Addr) -> IpAddr {
835 #[stable(feature = "ip_from_ip", since = "1.16.0")]
836 impl From<Ipv6Addr> for IpAddr {
837 /// Copies this address to a new `IpAddr::V6`.
842 /// use std::net::{IpAddr, Ipv6Addr};
844 /// let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);
847 /// IpAddr::V6(addr),
848 /// IpAddr::from(addr)
851 fn from(ipv6: Ipv6Addr) -> IpAddr {
856 #[stable(feature = "rust1", since = "1.0.0")]
857 impl fmt::Display for Ipv4Addr {
858 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
859 let octets = self.octets();
860 // Fast Path: if there's no alignment stuff, write directly to the buffer
861 if fmt.precision().is_none() && fmt.width().is_none() {
862 write!(fmt, "{}.{}.{}.{}", octets[0], octets[1], octets[2], octets[3])
864 const IPV4_BUF_LEN: usize = 15; // Long enough for the longest possible IPv4 address
865 let mut buf = [0u8; IPV4_BUF_LEN];
866 let mut buf_slice = &mut buf[..];
868 // Note: The call to write should never fail, hence the unwrap
869 write!(buf_slice, "{}.{}.{}.{}", octets[0], octets[1], octets[2], octets[3]).unwrap();
870 let len = IPV4_BUF_LEN - buf_slice.len();
872 // This unsafe is OK because we know what is being written to the buffer
873 let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
879 #[stable(feature = "rust1", since = "1.0.0")]
880 impl fmt::Debug for Ipv4Addr {
881 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
882 fmt::Display::fmt(self, fmt)
886 #[stable(feature = "rust1", since = "1.0.0")]
887 impl Clone for Ipv4Addr {
888 fn clone(&self) -> Ipv4Addr {
893 #[stable(feature = "rust1", since = "1.0.0")]
894 impl PartialEq for Ipv4Addr {
895 fn eq(&self, other: &Ipv4Addr) -> bool {
896 self.inner.s_addr == other.inner.s_addr
900 #[stable(feature = "ip_cmp", since = "1.16.0")]
901 impl PartialEq<Ipv4Addr> for IpAddr {
902 fn eq(&self, other: &Ipv4Addr) -> bool {
904 IpAddr::V4(v4) => v4 == other,
905 IpAddr::V6(_) => false,
910 #[stable(feature = "ip_cmp", since = "1.16.0")]
911 impl PartialEq<IpAddr> for Ipv4Addr {
912 fn eq(&self, other: &IpAddr) -> bool {
914 IpAddr::V4(v4) => self == v4,
915 IpAddr::V6(_) => false,
920 #[stable(feature = "rust1", since = "1.0.0")]
921 impl Eq for Ipv4Addr {}
923 #[stable(feature = "rust1", since = "1.0.0")]
924 impl hash::Hash for Ipv4Addr {
925 fn hash<H: hash::Hasher>(&self, s: &mut H) {
926 // `inner` is #[repr(packed)], so we need to copy `s_addr`.
927 { self.inner.s_addr }.hash(s)
931 #[stable(feature = "rust1", since = "1.0.0")]
932 impl PartialOrd for Ipv4Addr {
933 fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
934 Some(self.cmp(other))
938 #[stable(feature = "ip_cmp", since = "1.16.0")]
939 impl PartialOrd<Ipv4Addr> for IpAddr {
940 fn partial_cmp(&self, other: &Ipv4Addr) -> Option<Ordering> {
942 IpAddr::V4(v4) => v4.partial_cmp(other),
943 IpAddr::V6(_) => Some(Ordering::Greater),
948 #[stable(feature = "ip_cmp", since = "1.16.0")]
949 impl PartialOrd<IpAddr> for Ipv4Addr {
950 fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
952 IpAddr::V4(v4) => self.partial_cmp(v4),
953 IpAddr::V6(_) => Some(Ordering::Less),
958 #[stable(feature = "rust1", since = "1.0.0")]
959 impl Ord for Ipv4Addr {
960 fn cmp(&self, other: &Ipv4Addr) -> Ordering {
961 u32::from_be(self.inner.s_addr).cmp(&u32::from_be(other.inner.s_addr))
965 impl AsInner<c::in_addr> for Ipv4Addr {
966 fn as_inner(&self) -> &c::in_addr {
970 impl FromInner<c::in_addr> for Ipv4Addr {
971 fn from_inner(addr: c::in_addr) -> Ipv4Addr {
972 Ipv4Addr { inner: addr }
976 #[stable(feature = "ip_u32", since = "1.1.0")]
977 impl From<Ipv4Addr> for u32 {
978 /// Converts an `Ipv4Addr` into a host byte order `u32`.
983 /// use std::net::Ipv4Addr;
985 /// let addr = Ipv4Addr::new(13, 12, 11, 10);
986 /// assert_eq!(0x0d0c0b0au32, u32::from(addr));
988 fn from(ip: Ipv4Addr) -> u32 {
989 let ip = ip.octets();
990 u32::from_be_bytes(ip)
994 #[stable(feature = "ip_u32", since = "1.1.0")]
995 impl From<u32> for Ipv4Addr {
996 /// Converts a host byte order `u32` into an `Ipv4Addr`.
1001 /// use std::net::Ipv4Addr;
1003 /// let addr = Ipv4Addr::from(0x0d0c0b0au32);
1004 /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
1006 fn from(ip: u32) -> Ipv4Addr {
1007 Ipv4Addr::from(ip.to_be_bytes())
1011 #[stable(feature = "from_slice_v4", since = "1.9.0")]
1012 impl From<[u8; 4]> for Ipv4Addr {
1013 /// Creates an `Ipv4Addr` from a four element byte array.
1018 /// use std::net::Ipv4Addr;
1020 /// let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]);
1021 /// assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);
1023 fn from(octets: [u8; 4]) -> Ipv4Addr {
1024 Ipv4Addr::new(octets[0], octets[1], octets[2], octets[3])
1028 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1029 impl From<[u8; 4]> for IpAddr {
1030 /// Creates an `IpAddr::V4` from a four element byte array.
1035 /// use std::net::{IpAddr, Ipv4Addr};
1037 /// let addr = IpAddr::from([13u8, 12u8, 11u8, 10u8]);
1038 /// assert_eq!(IpAddr::V4(Ipv4Addr::new(13, 12, 11, 10)), addr);
1040 fn from(octets: [u8; 4]) -> IpAddr {
1041 IpAddr::V4(Ipv4Addr::from(octets))
1046 /// Creates a new IPv6 address from eight 16-bit segments.
1048 /// The result will represent the IP address `a:b:c:d:e:f:g:h`.
1053 /// use std::net::Ipv6Addr;
1055 /// let addr = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff);
1057 #[stable(feature = "rust1", since = "1.0.0")]
1058 #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1059 pub const fn new(a: u16, b: u16, c: u16, d: u16, e: u16, f: u16, g: u16, h: u16) -> Ipv6Addr {
1061 inner: c::in6_addr {
1084 /// An IPv6 address representing localhost: `::1`.
1089 /// use std::net::Ipv6Addr;
1091 /// let addr = Ipv6Addr::LOCALHOST;
1092 /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
1094 #[stable(feature = "ip_constructors", since = "1.30.0")]
1095 pub const LOCALHOST: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1);
1097 /// An IPv6 address representing the unspecified address: `::`
1102 /// use std::net::Ipv6Addr;
1104 /// let addr = Ipv6Addr::UNSPECIFIED;
1105 /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
1107 #[stable(feature = "ip_constructors", since = "1.30.0")]
1108 pub const UNSPECIFIED: Self = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0);
1110 /// Returns the eight 16-bit segments that make up this address.
1115 /// use std::net::Ipv6Addr;
1117 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).segments(),
1118 /// [0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff]);
1120 #[stable(feature = "rust1", since = "1.0.0")]
1121 pub fn segments(&self) -> [u16; 8] {
1122 let arr = &self.inner.s6_addr;
1124 u16::from_be_bytes([arr[0], arr[1]]),
1125 u16::from_be_bytes([arr[2], arr[3]]),
1126 u16::from_be_bytes([arr[4], arr[5]]),
1127 u16::from_be_bytes([arr[6], arr[7]]),
1128 u16::from_be_bytes([arr[8], arr[9]]),
1129 u16::from_be_bytes([arr[10], arr[11]]),
1130 u16::from_be_bytes([arr[12], arr[13]]),
1131 u16::from_be_bytes([arr[14], arr[15]]),
1135 /// Returns [`true`] for the special 'unspecified' address (::).
1137 /// This property is defined in [IETF RFC 4291].
1139 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1140 /// [`true`]: ../../std/primitive.bool.html
1145 /// use std::net::Ipv6Addr;
1147 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false);
1148 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);
1150 #[stable(since = "1.7.0", feature = "ip_17")]
1151 pub fn is_unspecified(&self) -> bool {
1152 self.segments() == [0, 0, 0, 0, 0, 0, 0, 0]
1155 /// Returns [`true`] if this is a loopback address (::1).
1157 /// This property is defined in [IETF RFC 4291].
1159 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1160 /// [`true`]: ../../std/primitive.bool.html
1165 /// use std::net::Ipv6Addr;
1167 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false);
1168 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);
1170 #[stable(since = "1.7.0", feature = "ip_17")]
1171 pub fn is_loopback(&self) -> bool {
1172 self.segments() == [0, 0, 0, 0, 0, 0, 0, 1]
1175 /// Returns [`true`] if the address appears to be globally routable.
1177 /// The following return [`false`]:
1179 /// - the loopback address
1180 /// - link-local and unique local unicast addresses
1181 /// - interface-, link-, realm-, admin- and site-local multicast addresses
1183 /// [`true`]: ../../std/primitive.bool.html
1184 /// [`false`]: ../../std/primitive.bool.html
1191 /// use std::net::Ipv6Addr;
1193 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true);
1194 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false);
1195 /// assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true);
1197 pub fn is_global(&self) -> bool {
1198 match self.multicast_scope() {
1199 Some(Ipv6MulticastScope::Global) => true,
1200 None => self.is_unicast_global(),
1205 /// Returns [`true`] if this is a unique local address (`fc00::/7`).
1207 /// This property is defined in [IETF RFC 4193].
1209 /// [IETF RFC 4193]: https://tools.ietf.org/html/rfc4193
1210 /// [`true`]: ../../std/primitive.bool.html
1217 /// use std::net::Ipv6Addr;
1219 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false);
1220 /// assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true);
1222 pub fn is_unique_local(&self) -> bool {
1223 (self.segments()[0] & 0xfe00) == 0xfc00
1226 /// Returns [`true`] if the address is a unicast link-local address (`fe80::/64`).
1228 /// A common mis-conception is to think that "unicast link-local addresses start with
1229 /// `fe80::`", but the [IETF RFC 4291] actually defines a stricter format for these addresses:
1233 /// | bits | 54 bits | 64 bits |
1234 /// +----------+-------------------------+----------------------------+
1235 /// |1111111010| 0 | interface ID |
1236 /// +----------+-------------------------+----------------------------+
1239 /// This method validates the format defined in the RFC and won't recognize the following
1240 /// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
1241 /// If you need a less strict validation use [`is_unicast_link_local()`] instead.
1248 /// use std::net::Ipv6Addr;
1250 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1251 /// assert!(ip.is_unicast_link_local_strict());
1253 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1254 /// assert!(ip.is_unicast_link_local_strict());
1256 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1257 /// assert!(!ip.is_unicast_link_local_strict());
1258 /// assert!(ip.is_unicast_link_local());
1260 /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1261 /// assert!(!ip.is_unicast_link_local_strict());
1262 /// assert!(ip.is_unicast_link_local());
1267 /// - [IETF RFC 4291 section 2.5.6]
1268 /// - [RFC 4291 errata 4406] (which has been rejected but provides useful
1270 /// - [`is_unicast_link_local()`]
1272 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1273 /// [IETF RFC 4291 section 2.5.6]: https://tools.ietf.org/html/rfc4291#section-2.5.6
1274 /// [`true`]: ../../std/primitive.bool.html
1275 /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1276 /// [`is_unicast_link_local()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local
1277 pub fn is_unicast_link_local_strict(&self) -> bool {
1278 (self.segments()[0] & 0xffff) == 0xfe80
1279 && (self.segments()[1] & 0xffff) == 0
1280 && (self.segments()[2] & 0xffff) == 0
1281 && (self.segments()[3] & 0xffff) == 0
1284 /// Returns [`true`] if the address is a unicast link-local address (`fe80::/10`).
1286 /// This method returns [`true`] for addresses in the range reserved by [RFC 4291 section 2.4],
1287 /// i.e. addresses with the following format:
1291 /// | bits | 54 bits | 64 bits |
1292 /// +----------+-------------------------+----------------------------+
1293 /// |1111111010| arbitratry value | interface ID |
1294 /// +----------+-------------------------+----------------------------+
1297 /// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
1298 /// unicast link-local addresses, whereas [`is_unicast_link_local_strict()`] does not. If you
1299 /// need a strict validation fully compliant with the RFC, use
1300 /// [`is_unicast_link_local_strict()`].
1307 /// use std::net::Ipv6Addr;
1309 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0, 0, 0, 0);
1310 /// assert!(ip.is_unicast_link_local());
1312 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 0, 0xffff, 0xffff, 0xffff, 0xffff);
1313 /// assert!(ip.is_unicast_link_local());
1315 /// let ip = Ipv6Addr::new(0xfe80, 0, 0, 1, 0, 0, 0, 0);
1316 /// assert!(ip.is_unicast_link_local());
1317 /// assert!(!ip.is_unicast_link_local_strict());
1319 /// let ip = Ipv6Addr::new(0xfe81, 0, 0, 0, 0, 0, 0, 0);
1320 /// assert!(ip.is_unicast_link_local());
1321 /// assert!(!ip.is_unicast_link_local_strict());
1326 /// - [IETF RFC 4291 section 2.4]
1327 /// - [RFC 4291 errata 4406] (which has been rejected but provides useful
1330 /// [IETF RFC 4291 section 2.4]: https://tools.ietf.org/html/rfc4291#section-2.4
1331 /// [`true`]: ../../std/primitive.bool.html
1332 /// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
1333 /// [`is_unicast_link_local_strict()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local_strict
1334 pub fn is_unicast_link_local(&self) -> bool {
1335 (self.segments()[0] & 0xffc0) == 0xfe80
1338 /// Returns [`true`] if this is a deprecated unicast site-local address (fec0::/10). The
1339 /// unicast site-local address format is defined in [RFC 4291 section 2.5.7] as:
1343 /// | bits | 54 bits | 64 bits |
1344 /// +----------+-------------------------+----------------------------+
1345 /// |1111111011| subnet ID | interface ID |
1346 /// +----------+-------------------------+----------------------------+
1349 /// [`true`]: ../../std/primitive.bool.html
1350 /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1357 /// use std::net::Ipv6Addr;
1360 /// Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_site_local(),
1363 /// assert_eq!(Ipv6Addr::new(0xfec2, 0, 0, 0, 0, 0, 0, 0).is_unicast_site_local(), true);
1368 /// As per [RFC 3879], the whole `FEC0::/10` prefix is
1369 /// deprecated. New software must not support site-local
1372 /// [RFC 3879]: https://tools.ietf.org/html/rfc3879
1373 pub fn is_unicast_site_local(&self) -> bool {
1374 (self.segments()[0] & 0xffc0) == 0xfec0
1377 /// Returns [`true`] if this is an address reserved for documentation
1378 /// (2001:db8::/32).
1380 /// This property is defined in [IETF RFC 3849].
1382 /// [IETF RFC 3849]: https://tools.ietf.org/html/rfc3849
1383 /// [`true`]: ../../std/primitive.bool.html
1390 /// use std::net::Ipv6Addr;
1392 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false);
1393 /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true);
1395 pub fn is_documentation(&self) -> bool {
1396 (self.segments()[0] == 0x2001) && (self.segments()[1] == 0xdb8)
1399 /// Returns [`true`] if the address is a globally routable unicast address.
1401 /// The following return false:
1403 /// - the loopback address
1404 /// - the link-local addresses
1405 /// - unique local addresses
1406 /// - the unspecified address
1407 /// - the address range reserved for documentation
1409 /// This method returns [`true`] for site-local addresses as per [RFC 4291 section 2.5.7]
1412 /// The special behavior of [the site-local unicast] prefix defined in [RFC3513] must no longer
1413 /// be supported in new implementations (i.e., new implementations must treat this prefix as
1414 /// Global Unicast).
1417 /// [`true`]: ../../std/primitive.bool.html
1418 /// [RFC 4291 section 2.5.7]: https://tools.ietf.org/html/rfc4291#section-2.5.7
1425 /// use std::net::Ipv6Addr;
1427 /// assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false);
1428 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true);
1430 pub fn is_unicast_global(&self) -> bool {
1431 !self.is_multicast()
1432 && !self.is_loopback()
1433 && !self.is_unicast_link_local()
1434 && !self.is_unique_local()
1435 && !self.is_unspecified()
1436 && !self.is_documentation()
1439 /// Returns the address's multicast scope if the address is multicast.
1446 /// use std::net::{Ipv6Addr, Ipv6MulticastScope};
1449 /// Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(),
1450 /// Some(Ipv6MulticastScope::Global)
1452 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None);
1454 pub fn multicast_scope(&self) -> Option<Ipv6MulticastScope> {
1455 if self.is_multicast() {
1456 match self.segments()[0] & 0x000f {
1457 1 => Some(Ipv6MulticastScope::InterfaceLocal),
1458 2 => Some(Ipv6MulticastScope::LinkLocal),
1459 3 => Some(Ipv6MulticastScope::RealmLocal),
1460 4 => Some(Ipv6MulticastScope::AdminLocal),
1461 5 => Some(Ipv6MulticastScope::SiteLocal),
1462 8 => Some(Ipv6MulticastScope::OrganizationLocal),
1463 14 => Some(Ipv6MulticastScope::Global),
1471 /// Returns [`true`] if this is a multicast address (ff00::/8).
1473 /// This property is defined by [IETF RFC 4291].
1475 /// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
1476 /// [`true`]: ../../std/primitive.bool.html
1481 /// use std::net::Ipv6Addr;
1483 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true);
1484 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);
1486 #[stable(since = "1.7.0", feature = "ip_17")]
1487 pub fn is_multicast(&self) -> bool {
1488 (self.segments()[0] & 0xff00) == 0xff00
1491 /// Converts this address to an [IPv4 address]. Returns [`None`] if this address is
1492 /// neither IPv4-compatible or IPv4-mapped.
1494 /// ::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d
1496 /// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
1497 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1502 /// use std::net::{Ipv4Addr, Ipv6Addr};
1504 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None);
1505 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(),
1506 /// Some(Ipv4Addr::new(192, 10, 2, 255)));
1507 /// assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(),
1508 /// Some(Ipv4Addr::new(0, 0, 0, 1)));
1510 #[stable(feature = "rust1", since = "1.0.0")]
1511 pub fn to_ipv4(&self) -> Option<Ipv4Addr> {
1512 match self.segments() {
1513 [0, 0, 0, 0, 0, f, g, h] if f == 0 || f == 0xffff => {
1514 Some(Ipv4Addr::new((g >> 8) as u8, g as u8, (h >> 8) as u8, h as u8))
1520 /// Returns the sixteen eight-bit integers the IPv6 address consists of.
1523 /// use std::net::Ipv6Addr;
1525 /// assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).octets(),
1526 /// [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
1528 #[stable(feature = "ipv6_to_octets", since = "1.12.0")]
1529 #[rustc_const_stable(feature = "const_ipv6", since = "1.32.0")]
1530 pub const fn octets(&self) -> [u8; 16] {
1535 /// Write an Ipv6Addr, conforming to the canonical style described by
1536 /// [RFC 5952](https://tools.ietf.org/html/rfc5952).
1537 #[stable(feature = "rust1", since = "1.0.0")]
1538 impl fmt::Display for Ipv6Addr {
1539 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1540 // If there are no alignment requirements, write out the IP address to
1541 // f. Otherwise, write it to a local buffer, then use f.pad.
1542 if f.precision().is_none() && f.width().is_none() {
1543 let segments = self.segments();
1545 // Special case for :: and ::1; otherwise they get written with the
1547 if self.is_unspecified() {
1549 } else if self.is_loopback() {
1551 } else if let Some(ipv4) = self.to_ipv4() {
1553 // IPv4 Compatible address
1554 0 => write!(f, "::{}", ipv4),
1555 // IPv4 Mapped address
1556 0xffff => write!(f, "::ffff:{}", ipv4),
1557 _ => unreachable!(),
1560 #[derive(Copy, Clone, Default)]
1566 // Find the inner 0 span
1568 let mut longest = Span::default();
1569 let mut current = Span::default();
1571 for (i, &segment) in segments.iter().enumerate() {
1573 if current.len == 0 {
1579 if current.len > longest.len {
1583 current = Span::default();
1590 /// Write a colon-separated part of the address
1592 fn fmt_subslice(f: &mut fmt::Formatter<'_>, chunk: &[u16]) -> fmt::Result {
1593 if let Some(first) = chunk.first() {
1594 fmt::LowerHex::fmt(first, f)?;
1595 for segment in &chunk[1..] {
1597 fmt::LowerHex::fmt(segment, f)?;
1604 fmt_subslice(f, &segments[..zeroes.start])?;
1606 fmt_subslice(f, &segments[zeroes.start + zeroes.len..])
1608 fmt_subslice(f, &segments)
1612 // Slow path: write the address to a local buffer, the use f.pad.
1613 // Defined recursively by using the fast path to write to the
1616 // This is the largest possible size of an IPv6 address
1617 const IPV6_BUF_LEN: usize = (4 * 8) + 7;
1618 let mut buf = [0u8; IPV6_BUF_LEN];
1619 let mut buf_slice = &mut buf[..];
1621 // Note: This call to write should never fail, so unwrap is okay.
1622 write!(buf_slice, "{}", self).unwrap();
1623 let len = IPV6_BUF_LEN - buf_slice.len();
1625 // This is safe because we know exactly what can be in this buffer
1626 let buf = unsafe { crate::str::from_utf8_unchecked(&buf[..len]) };
1632 #[stable(feature = "rust1", since = "1.0.0")]
1633 impl fmt::Debug for Ipv6Addr {
1634 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1635 fmt::Display::fmt(self, fmt)
1639 #[stable(feature = "rust1", since = "1.0.0")]
1640 impl Clone for Ipv6Addr {
1641 fn clone(&self) -> Ipv6Addr {
1646 #[stable(feature = "rust1", since = "1.0.0")]
1647 impl PartialEq for Ipv6Addr {
1648 fn eq(&self, other: &Ipv6Addr) -> bool {
1649 self.inner.s6_addr == other.inner.s6_addr
1653 #[stable(feature = "ip_cmp", since = "1.16.0")]
1654 impl PartialEq<IpAddr> for Ipv6Addr {
1655 fn eq(&self, other: &IpAddr) -> bool {
1657 IpAddr::V4(_) => false,
1658 IpAddr::V6(v6) => self == v6,
1663 #[stable(feature = "ip_cmp", since = "1.16.0")]
1664 impl PartialEq<Ipv6Addr> for IpAddr {
1665 fn eq(&self, other: &Ipv6Addr) -> bool {
1667 IpAddr::V4(_) => false,
1668 IpAddr::V6(v6) => v6 == other,
1673 #[stable(feature = "rust1", since = "1.0.0")]
1674 impl Eq for Ipv6Addr {}
1676 #[stable(feature = "rust1", since = "1.0.0")]
1677 impl hash::Hash for Ipv6Addr {
1678 fn hash<H: hash::Hasher>(&self, s: &mut H) {
1679 self.inner.s6_addr.hash(s)
1683 #[stable(feature = "rust1", since = "1.0.0")]
1684 impl PartialOrd for Ipv6Addr {
1685 fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1686 Some(self.cmp(other))
1690 #[stable(feature = "ip_cmp", since = "1.16.0")]
1691 impl PartialOrd<Ipv6Addr> for IpAddr {
1692 fn partial_cmp(&self, other: &Ipv6Addr) -> Option<Ordering> {
1694 IpAddr::V4(_) => Some(Ordering::Less),
1695 IpAddr::V6(v6) => v6.partial_cmp(other),
1700 #[stable(feature = "ip_cmp", since = "1.16.0")]
1701 impl PartialOrd<IpAddr> for Ipv6Addr {
1702 fn partial_cmp(&self, other: &IpAddr) -> Option<Ordering> {
1704 IpAddr::V4(_) => Some(Ordering::Greater),
1705 IpAddr::V6(v6) => self.partial_cmp(v6),
1710 #[stable(feature = "rust1", since = "1.0.0")]
1711 impl Ord for Ipv6Addr {
1712 fn cmp(&self, other: &Ipv6Addr) -> Ordering {
1713 self.segments().cmp(&other.segments())
1717 impl AsInner<c::in6_addr> for Ipv6Addr {
1718 fn as_inner(&self) -> &c::in6_addr {
1722 impl FromInner<c::in6_addr> for Ipv6Addr {
1723 fn from_inner(addr: c::in6_addr) -> Ipv6Addr {
1724 Ipv6Addr { inner: addr }
1728 #[stable(feature = "i128", since = "1.26.0")]
1729 impl From<Ipv6Addr> for u128 {
1730 /// Convert an `Ipv6Addr` into a host byte order `u128`.
1735 /// use std::net::Ipv6Addr;
1737 /// let addr = Ipv6Addr::new(
1738 /// 0x1020, 0x3040, 0x5060, 0x7080,
1739 /// 0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1741 /// assert_eq!(0x102030405060708090A0B0C0D0E0F00D_u128, u128::from(addr));
1743 fn from(ip: Ipv6Addr) -> u128 {
1744 let ip = ip.octets();
1745 u128::from_be_bytes(ip)
1748 #[stable(feature = "i128", since = "1.26.0")]
1749 impl From<u128> for Ipv6Addr {
1750 /// Convert a host byte order `u128` into an `Ipv6Addr`.
1755 /// use std::net::Ipv6Addr;
1757 /// let addr = Ipv6Addr::from(0x102030405060708090A0B0C0D0E0F00D_u128);
1760 /// 0x1020, 0x3040, 0x5060, 0x7080,
1761 /// 0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
1765 fn from(ip: u128) -> Ipv6Addr {
1766 Ipv6Addr::from(ip.to_be_bytes())
1770 #[stable(feature = "ipv6_from_octets", since = "1.9.0")]
1771 impl From<[u8; 16]> for Ipv6Addr {
1772 /// Creates an `Ipv6Addr` from a sixteen element byte array.
1777 /// use std::net::Ipv6Addr;
1779 /// let addr = Ipv6Addr::from([
1780 /// 25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
1781 /// 17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
1793 fn from(octets: [u8; 16]) -> Ipv6Addr {
1794 let inner = c::in6_addr { s6_addr: octets };
1795 Ipv6Addr::from_inner(inner)
1799 #[stable(feature = "ipv6_from_segments", since = "1.16.0")]
1800 impl From<[u16; 8]> for Ipv6Addr {
1801 /// Creates an `Ipv6Addr` from an eight element 16-bit array.
1806 /// use std::net::Ipv6Addr;
1808 /// let addr = Ipv6Addr::from([
1809 /// 525u16, 524u16, 523u16, 522u16,
1810 /// 521u16, 520u16, 519u16, 518u16,
1822 fn from(segments: [u16; 8]) -> Ipv6Addr {
1823 let [a, b, c, d, e, f, g, h] = segments;
1824 Ipv6Addr::new(a, b, c, d, e, f, g, h)
1828 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1829 impl From<[u8; 16]> for IpAddr {
1830 /// Creates an `IpAddr::V6` from a sixteen element byte array.
1835 /// use std::net::{IpAddr, Ipv6Addr};
1837 /// let addr = IpAddr::from([
1838 /// 25u8, 24u8, 23u8, 22u8, 21u8, 20u8, 19u8, 18u8,
1839 /// 17u8, 16u8, 15u8, 14u8, 13u8, 12u8, 11u8, 10u8,
1842 /// IpAddr::V6(Ipv6Addr::new(
1851 fn from(octets: [u8; 16]) -> IpAddr {
1852 IpAddr::V6(Ipv6Addr::from(octets))
1856 #[stable(feature = "ip_from_slice", since = "1.17.0")]
1857 impl From<[u16; 8]> for IpAddr {
1858 /// Creates an `IpAddr::V6` from an eight element 16-bit array.
1863 /// use std::net::{IpAddr, Ipv6Addr};
1865 /// let addr = IpAddr::from([
1866 /// 525u16, 524u16, 523u16, 522u16,
1867 /// 521u16, 520u16, 519u16, 518u16,
1870 /// IpAddr::V6(Ipv6Addr::new(
1879 fn from(segments: [u16; 8]) -> IpAddr {
1880 IpAddr::V6(Ipv6Addr::from(segments))
1884 // Tests for this module
1885 #[cfg(all(test, not(target_os = "emscripten")))]
1887 use crate::net::test::{sa4, sa6, tsa};
1889 use crate::str::FromStr;
1892 fn test_from_str_ipv4() {
1893 assert_eq!(Ok(Ipv4Addr::new(127, 0, 0, 1)), "127.0.0.1".parse());
1894 assert_eq!(Ok(Ipv4Addr::new(255, 255, 255, 255)), "255.255.255.255".parse());
1895 assert_eq!(Ok(Ipv4Addr::new(0, 0, 0, 0)), "0.0.0.0".parse());
1898 let none: Option<Ipv4Addr> = "256.0.0.1".parse().ok();
1899 assert_eq!(None, none);
1901 let none: Option<Ipv4Addr> = "255.0.0".parse().ok();
1902 assert_eq!(None, none);
1904 let none: Option<Ipv4Addr> = "255.0.0.1.2".parse().ok();
1905 assert_eq!(None, none);
1906 // no number between dots
1907 let none: Option<Ipv4Addr> = "255.0..1".parse().ok();
1908 assert_eq!(None, none);
1912 fn test_from_str_ipv6() {
1913 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "0:0:0:0:0:0:0:0".parse());
1914 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "0:0:0:0:0:0:0:1".parse());
1916 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)), "::1".parse());
1917 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), "::".parse());
1920 Ok(Ipv6Addr::new(0x2a02, 0x6b8, 0, 0, 0, 0, 0x11, 0x11)),
1921 "2a02:6b8::11:11".parse()
1925 let none: Option<Ipv6Addr> = "::00000".parse().ok();
1926 assert_eq!(None, none);
1928 let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7".parse().ok();
1929 assert_eq!(None, none);
1931 let none: Option<Ipv6Addr> = "1:2:3:4:5:6:7:8:9".parse().ok();
1932 assert_eq!(None, none);
1934 let none: Option<Ipv6Addr> = "1:2:::6:7:8".parse().ok();
1935 assert_eq!(None, none);
1936 // two double colons
1937 let none: Option<Ipv6Addr> = "1:2::6::8".parse().ok();
1938 assert_eq!(None, none);
1939 // `::` indicating zero groups of zeros
1940 let none: Option<Ipv6Addr> = "1:2:3:4::5:6:7:8".parse().ok();
1941 assert_eq!(None, none);
1945 fn test_from_str_ipv4_in_ipv6() {
1946 assert_eq!(Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 545)), "::192.0.2.33".parse());
1948 Ok(Ipv6Addr::new(0, 0, 0, 0, 0, 0xFFFF, 49152, 545)),
1949 "::FFFF:192.0.2.33".parse()
1952 Ok(Ipv6Addr::new(0x64, 0xff9b, 0, 0, 0, 0, 49152, 545)),
1953 "64:ff9b::192.0.2.33".parse()
1956 Ok(Ipv6Addr::new(0x2001, 0xdb8, 0x122, 0xc000, 0x2, 0x2100, 49152, 545)),
1957 "2001:db8:122:c000:2:2100:192.0.2.33".parse()
1961 let none: Option<Ipv4Addr> = "::127.0.0.1:".parse().ok();
1962 assert_eq!(None, none);
1963 // not enough groups
1964 let none: Option<Ipv6Addr> = "1.2.3.4.5:127.0.0.1".parse().ok();
1965 assert_eq!(None, none);
1967 let none: Option<Ipv6Addr> = "1.2.3.4.5:6:7:127.0.0.1".parse().ok();
1968 assert_eq!(None, none);
1972 fn test_from_str_socket_addr() {
1973 assert_eq!(Ok(sa4(Ipv4Addr::new(77, 88, 21, 11), 80)), "77.88.21.11:80".parse());
1975 Ok(SocketAddrV4::new(Ipv4Addr::new(77, 88, 21, 11), 80)),
1976 "77.88.21.11:80".parse()
1979 Ok(sa6(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53)),
1980 "[2a02:6b8:0:1::1]:53".parse()
1983 Ok(SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53, 0, 0)),
1984 "[2a02:6b8:0:1::1]:53".parse()
1987 Ok(sa6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22)),
1988 "[::127.0.0.1]:22".parse()
1991 Ok(SocketAddrV6::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x7F00, 1), 22, 0, 0)),
1992 "[::127.0.0.1]:22".parse()
1996 let none: Option<SocketAddr> = "127.0.0.1".parse().ok();
1997 assert_eq!(None, none);
1999 let none: Option<SocketAddr> = "127.0.0.1:".parse().ok();
2000 assert_eq!(None, none);
2001 // wrong brackets around v4
2002 let none: Option<SocketAddr> = "[127.0.0.1]:22".parse().ok();
2003 assert_eq!(None, none);
2004 // port out of range
2005 let none: Option<SocketAddr> = "127.0.0.1:123456".parse().ok();
2006 assert_eq!(None, none);
2010 fn ipv4_addr_to_string() {
2012 assert_eq!(Ipv4Addr::new(1, 1, 1, 1).to_string(), "1.1.1.1");
2014 assert_eq!(Ipv4Addr::new(127, 127, 127, 127).to_string(), "127.127.127.127");
2017 assert_eq!(&format!("{:16}", Ipv4Addr::new(1, 1, 1, 1)), "1.1.1.1 ");
2018 assert_eq!(&format!("{:>16}", Ipv4Addr::new(1, 1, 1, 1)), " 1.1.1.1");
2022 fn ipv6_addr_to_string() {
2023 // ipv4-mapped address
2024 let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc000, 0x280);
2025 assert_eq!(a1.to_string(), "::ffff:192.0.2.128");
2027 // ipv4-compatible address
2028 let a1 = Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0xc000, 0x280);
2029 assert_eq!(a1.to_string(), "::192.0.2.128");
2031 // v6 address with no zero segments
2032 assert_eq!(Ipv6Addr::new(8, 9, 10, 11, 12, 13, 14, 15).to_string(), "8:9:a:b:c:d:e:f");
2034 // longest possible IPv6 length
2036 Ipv6Addr::new(0x1111, 0x2222, 0x3333, 0x4444, 0x5555, 0x6666, 0x7777, 0x8888)
2038 "1111:2222:3333:4444:5555:6666:7777:8888"
2042 &format!("{:20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
2046 &format!("{:>20}", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 7, 8)),
2050 // reduce a single run of zeros
2053 Ipv6Addr::new(0xae, 0, 0, 0, 0, 0xffff, 0x0102, 0x0304).to_string()
2056 // don't reduce just a single zero segment
2057 assert_eq!("1:2:3:4:5:6:0:8", Ipv6Addr::new(1, 2, 3, 4, 5, 6, 0, 8).to_string());
2060 assert_eq!("::", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).to_string());
2063 assert_eq!("::1", Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_string());
2066 assert_eq!("1::", Ipv6Addr::new(1, 0, 0, 0, 0, 0, 0, 0).to_string());
2068 // two runs of zeros, second one is longer
2069 assert_eq!("1:0:0:4::8", Ipv6Addr::new(1, 0, 0, 4, 0, 0, 0, 8).to_string());
2071 // two runs of zeros, equal length
2072 assert_eq!("1::4:5:0:0:8", Ipv6Addr::new(1, 0, 0, 4, 5, 0, 0, 8).to_string());
2078 Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678),
2079 Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_mapped()
2082 Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678),
2083 Ipv4Addr::new(0x12, 0x34, 0x56, 0x78).to_ipv6_compatible()
2090 Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678).to_ipv4(),
2091 Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2094 Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0x1234, 0x5678).to_ipv4(),
2095 Some(Ipv4Addr::new(0x12, 0x34, 0x56, 0x78))
2097 assert_eq!(Ipv6Addr::new(0, 0, 1, 0, 0, 0, 0x1234, 0x5678).to_ipv4(), None);
2101 fn ip_properties() {
2104 IpAddr::from_str($s).unwrap()
2108 macro_rules! check {
2113 ($s:expr, $mask:expr) => {{
2114 let unspec: u8 = 1 << 0;
2115 let loopback: u8 = 1 << 1;
2116 let global: u8 = 1 << 2;
2117 let multicast: u8 = 1 << 3;
2118 let doc: u8 = 1 << 4;
2120 if ($mask & unspec) == unspec {
2121 assert!(ip!($s).is_unspecified());
2123 assert!(!ip!($s).is_unspecified());
2126 if ($mask & loopback) == loopback {
2127 assert!(ip!($s).is_loopback());
2129 assert!(!ip!($s).is_loopback());
2132 if ($mask & global) == global {
2133 assert!(ip!($s).is_global());
2135 assert!(!ip!($s).is_global());
2138 if ($mask & multicast) == multicast {
2139 assert!(ip!($s).is_multicast());
2141 assert!(!ip!($s).is_multicast());
2144 if ($mask & doc) == doc {
2145 assert!(ip!($s).is_documentation());
2147 assert!(!ip!($s).is_documentation());
2152 let unspec: u8 = 1 << 0;
2153 let loopback: u8 = 1 << 1;
2154 let global: u8 = 1 << 2;
2155 let multicast: u8 = 1 << 3;
2156 let doc: u8 = 1 << 4;
2158 check!("0.0.0.0", unspec);
2162 check!("127.1.2.3", loopback);
2163 check!("172.31.254.253");
2164 check!("169.254.253.242");
2165 check!("192.0.2.183", doc);
2166 check!("192.1.2.183", global);
2167 check!("192.168.254.253");
2168 check!("198.51.100.0", doc);
2169 check!("203.0.113.0", doc);
2170 check!("203.2.113.0", global);
2171 check!("224.0.0.0", global | multicast);
2172 check!("239.255.255.255", global | multicast);
2173 check!("255.255.255.255");
2174 // make sure benchmarking addresses are not global
2175 check!("198.18.0.0");
2176 check!("198.18.54.2");
2177 check!("198.19.255.255");
2178 // make sure addresses reserved for protocol assignment are not global
2179 check!("192.0.0.0");
2180 check!("192.0.0.255");
2181 check!("192.0.0.100");
2182 // make sure reserved addresses are not global
2183 check!("240.0.0.0");
2184 check!("251.54.1.76");
2185 check!("254.255.255.255");
2186 // make sure shared addresses are not global
2187 check!("100.64.0.0");
2188 check!("100.127.255.255");
2189 check!("100.100.100.0");
2191 check!("::", unspec);
2192 check!("::1", loopback);
2193 check!("::0.0.0.2", global);
2194 check!("1::", global);
2196 check!("fdff:ffff::");
2197 check!("fe80:ffff::");
2198 check!("febf:ffff::");
2199 check!("fec0::", global);
2200 check!("ff01::", multicast);
2201 check!("ff02::", multicast);
2202 check!("ff03::", multicast);
2203 check!("ff04::", multicast);
2204 check!("ff05::", multicast);
2205 check!("ff08::", multicast);
2206 check!("ff0e::", global | multicast);
2207 check!("2001:db8:85a3::8a2e:370:7334", doc);
2208 check!("102:304:506:708:90a:b0c:d0e:f10", global);
2212 fn ipv4_properties() {
2215 Ipv4Addr::from_str($s).unwrap()
2219 macro_rules! check {
2224 ($s:expr, $mask:expr) => {{
2225 let unspec: u16 = 1 << 0;
2226 let loopback: u16 = 1 << 1;
2227 let private: u16 = 1 << 2;
2228 let link_local: u16 = 1 << 3;
2229 let global: u16 = 1 << 4;
2230 let multicast: u16 = 1 << 5;
2231 let broadcast: u16 = 1 << 6;
2232 let documentation: u16 = 1 << 7;
2233 let benchmarking: u16 = 1 << 8;
2234 let ietf_protocol_assignment: u16 = 1 << 9;
2235 let reserved: u16 = 1 << 10;
2236 let shared: u16 = 1 << 11;
2238 if ($mask & unspec) == unspec {
2239 assert!(ip!($s).is_unspecified());
2241 assert!(!ip!($s).is_unspecified());
2244 if ($mask & loopback) == loopback {
2245 assert!(ip!($s).is_loopback());
2247 assert!(!ip!($s).is_loopback());
2250 if ($mask & private) == private {
2251 assert!(ip!($s).is_private());
2253 assert!(!ip!($s).is_private());
2256 if ($mask & link_local) == link_local {
2257 assert!(ip!($s).is_link_local());
2259 assert!(!ip!($s).is_link_local());
2262 if ($mask & global) == global {
2263 assert!(ip!($s).is_global());
2265 assert!(!ip!($s).is_global());
2268 if ($mask & multicast) == multicast {
2269 assert!(ip!($s).is_multicast());
2271 assert!(!ip!($s).is_multicast());
2274 if ($mask & broadcast) == broadcast {
2275 assert!(ip!($s).is_broadcast());
2277 assert!(!ip!($s).is_broadcast());
2280 if ($mask & documentation) == documentation {
2281 assert!(ip!($s).is_documentation());
2283 assert!(!ip!($s).is_documentation());
2286 if ($mask & benchmarking) == benchmarking {
2287 assert!(ip!($s).is_benchmarking());
2289 assert!(!ip!($s).is_benchmarking());
2292 if ($mask & ietf_protocol_assignment) == ietf_protocol_assignment {
2293 assert!(ip!($s).is_ietf_protocol_assignment());
2295 assert!(!ip!($s).is_ietf_protocol_assignment());
2298 if ($mask & reserved) == reserved {
2299 assert!(ip!($s).is_reserved());
2301 assert!(!ip!($s).is_reserved());
2304 if ($mask & shared) == shared {
2305 assert!(ip!($s).is_shared());
2307 assert!(!ip!($s).is_shared());
2312 let unspec: u16 = 1 << 0;
2313 let loopback: u16 = 1 << 1;
2314 let private: u16 = 1 << 2;
2315 let link_local: u16 = 1 << 3;
2316 let global: u16 = 1 << 4;
2317 let multicast: u16 = 1 << 5;
2318 let broadcast: u16 = 1 << 6;
2319 let documentation: u16 = 1 << 7;
2320 let benchmarking: u16 = 1 << 8;
2321 let ietf_protocol_assignment: u16 = 1 << 9;
2322 let reserved: u16 = 1 << 10;
2323 let shared: u16 = 1 << 11;
2325 check!("0.0.0.0", unspec);
2328 check!("10.9.8.7", private);
2329 check!("127.1.2.3", loopback);
2330 check!("172.31.254.253", private);
2331 check!("169.254.253.242", link_local);
2332 check!("192.0.2.183", documentation);
2333 check!("192.1.2.183", global);
2334 check!("192.168.254.253", private);
2335 check!("198.51.100.0", documentation);
2336 check!("203.0.113.0", documentation);
2337 check!("203.2.113.0", global);
2338 check!("224.0.0.0", global | multicast);
2339 check!("239.255.255.255", global | multicast);
2340 check!("255.255.255.255", broadcast);
2341 check!("198.18.0.0", benchmarking);
2342 check!("198.18.54.2", benchmarking);
2343 check!("198.19.255.255", benchmarking);
2344 check!("192.0.0.0", ietf_protocol_assignment);
2345 check!("192.0.0.255", ietf_protocol_assignment);
2346 check!("192.0.0.100", ietf_protocol_assignment);
2347 check!("240.0.0.0", reserved);
2348 check!("251.54.1.76", reserved);
2349 check!("254.255.255.255", reserved);
2350 check!("100.64.0.0", shared);
2351 check!("100.127.255.255", shared);
2352 check!("100.100.100.0", shared);
2356 fn ipv6_properties() {
2359 Ipv6Addr::from_str($s).unwrap()
2363 macro_rules! check {
2364 ($s:expr, &[$($octet:expr),*], $mask:expr) => {
2365 assert_eq!($s, ip!($s).to_string());
2366 let octets = &[$($octet),*];
2367 assert_eq!(&ip!($s).octets(), octets);
2368 assert_eq!(Ipv6Addr::from(*octets), ip!($s));
2370 let unspecified: u16 = 1 << 0;
2371 let loopback: u16 = 1 << 1;
2372 let unique_local: u16 = 1 << 2;
2373 let global: u16 = 1 << 3;
2374 let unicast_link_local: u16 = 1 << 4;
2375 let unicast_link_local_strict: u16 = 1 << 5;
2376 let unicast_site_local: u16 = 1 << 6;
2377 let unicast_global: u16 = 1 << 7;
2378 let documentation: u16 = 1 << 8;
2379 let multicast_interface_local: u16 = 1 << 9;
2380 let multicast_link_local: u16 = 1 << 10;
2381 let multicast_realm_local: u16 = 1 << 11;
2382 let multicast_admin_local: u16 = 1 << 12;
2383 let multicast_site_local: u16 = 1 << 13;
2384 let multicast_organization_local: u16 = 1 << 14;
2385 let multicast_global: u16 = 1 << 15;
2386 let multicast: u16 = multicast_interface_local
2387 | multicast_admin_local
2389 | multicast_link_local
2390 | multicast_realm_local
2391 | multicast_site_local
2392 | multicast_organization_local;
2394 if ($mask & unspecified) == unspecified {
2395 assert!(ip!($s).is_unspecified());
2397 assert!(!ip!($s).is_unspecified());
2399 if ($mask & loopback) == loopback {
2400 assert!(ip!($s).is_loopback());
2402 assert!(!ip!($s).is_loopback());
2404 if ($mask & unique_local) == unique_local {
2405 assert!(ip!($s).is_unique_local());
2407 assert!(!ip!($s).is_unique_local());
2409 if ($mask & global) == global {
2410 assert!(ip!($s).is_global());
2412 assert!(!ip!($s).is_global());
2414 if ($mask & unicast_link_local) == unicast_link_local {
2415 assert!(ip!($s).is_unicast_link_local());
2417 assert!(!ip!($s).is_unicast_link_local());
2419 if ($mask & unicast_link_local_strict) == unicast_link_local_strict {
2420 assert!(ip!($s).is_unicast_link_local_strict());
2422 assert!(!ip!($s).is_unicast_link_local_strict());
2424 if ($mask & unicast_site_local) == unicast_site_local {
2425 assert!(ip!($s).is_unicast_site_local());
2427 assert!(!ip!($s).is_unicast_site_local());
2429 if ($mask & unicast_global) == unicast_global {
2430 assert!(ip!($s).is_unicast_global());
2432 assert!(!ip!($s).is_unicast_global());
2434 if ($mask & documentation) == documentation {
2435 assert!(ip!($s).is_documentation());
2437 assert!(!ip!($s).is_documentation());
2439 if ($mask & multicast) != 0 {
2440 assert!(ip!($s).multicast_scope().is_some());
2441 assert!(ip!($s).is_multicast());
2443 assert!(ip!($s).multicast_scope().is_none());
2444 assert!(!ip!($s).is_multicast());
2446 if ($mask & multicast_interface_local) == multicast_interface_local {
2447 assert_eq!(ip!($s).multicast_scope().unwrap(),
2448 Ipv6MulticastScope::InterfaceLocal);
2450 if ($mask & multicast_link_local) == multicast_link_local {
2451 assert_eq!(ip!($s).multicast_scope().unwrap(),
2452 Ipv6MulticastScope::LinkLocal);
2454 if ($mask & multicast_realm_local) == multicast_realm_local {
2455 assert_eq!(ip!($s).multicast_scope().unwrap(),
2456 Ipv6MulticastScope::RealmLocal);
2458 if ($mask & multicast_admin_local) == multicast_admin_local {
2459 assert_eq!(ip!($s).multicast_scope().unwrap(),
2460 Ipv6MulticastScope::AdminLocal);
2462 if ($mask & multicast_site_local) == multicast_site_local {
2463 assert_eq!(ip!($s).multicast_scope().unwrap(),
2464 Ipv6MulticastScope::SiteLocal);
2466 if ($mask & multicast_organization_local) == multicast_organization_local {
2467 assert_eq!(ip!($s).multicast_scope().unwrap(),
2468 Ipv6MulticastScope::OrganizationLocal);
2470 if ($mask & multicast_global) == multicast_global {
2471 assert_eq!(ip!($s).multicast_scope().unwrap(),
2472 Ipv6MulticastScope::Global);
2477 let unspecified: u16 = 1 << 0;
2478 let loopback: u16 = 1 << 1;
2479 let unique_local: u16 = 1 << 2;
2480 let global: u16 = 1 << 3;
2481 let unicast_link_local: u16 = 1 << 4;
2482 let unicast_link_local_strict: u16 = 1 << 5;
2483 let unicast_site_local: u16 = 1 << 6;
2484 let unicast_global: u16 = 1 << 7;
2485 let documentation: u16 = 1 << 8;
2486 let multicast_interface_local: u16 = 1 << 9;
2487 let multicast_link_local: u16 = 1 << 10;
2488 let multicast_realm_local: u16 = 1 << 11;
2489 let multicast_admin_local: u16 = 1 << 12;
2490 let multicast_site_local: u16 = 1 << 13;
2491 let multicast_organization_local: u16 = 1 << 14;
2492 let multicast_global: u16 = 1 << 15;
2494 check!("::", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unspecified);
2496 check!("::1", &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1], loopback);
2500 &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2],
2501 global | unicast_global
2504 check!("1::", &[0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], global | unicast_global);
2506 check!("fc00::", &[0xfc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], unique_local);
2510 &[0xfd, 0xff, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2516 &[0xfe, 0x80, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2522 &[0xfe, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2523 unicast_link_local | unicast_link_local_strict
2528 &[0xfe, 0xbf, 0xff, 0xff, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2534 &[0xfe, 0xbf, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2539 "febf:ffff:ffff:ffff:ffff:ffff:ffff:ffff",
2541 0xfe, 0xbf, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2548 "fe80::ffff:ffff:ffff:ffff",
2550 0xfe, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
2553 unicast_link_local | unicast_link_local_strict
2558 &[0xfe, 0x80, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
2564 &[0xfe, 0xc0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2565 unicast_site_local | unicast_global | global
2570 &[0xff, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2571 multicast_interface_local
2576 &[0xff, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2577 multicast_link_local
2582 &[0xff, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2583 multicast_realm_local
2588 &[0xff, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2589 multicast_admin_local
2594 &[0xff, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2595 multicast_site_local
2600 &[0xff, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2601 multicast_organization_local
2606 &[0xff, 0xe, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
2607 multicast_global | global
2611 "2001:db8:85a3::8a2e:370:7334",
2612 &[0x20, 1, 0xd, 0xb8, 0x85, 0xa3, 0, 0, 0, 0, 0x8a, 0x2e, 3, 0x70, 0x73, 0x34],
2617 "102:304:506:708:90a:b0c:d0e:f10",
2618 &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16],
2619 global | unicast_global
2624 fn to_socket_addr_socketaddr() {
2625 let a = sa4(Ipv4Addr::new(77, 88, 21, 11), 12345);
2626 assert_eq!(Ok(vec![a]), tsa(a));
2630 fn test_ipv4_to_int() {
2631 let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2632 assert_eq!(u32::from(a), 0x11223344);
2636 fn test_int_to_ipv4() {
2637 let a = Ipv4Addr::new(0x11, 0x22, 0x33, 0x44);
2638 assert_eq!(Ipv4Addr::from(0x11223344), a);
2642 fn test_ipv6_to_int() {
2643 let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2644 assert_eq!(u128::from(a), 0x112233445566778899aabbccddeeff11u128);
2648 fn test_int_to_ipv6() {
2649 let a = Ipv6Addr::new(0x1122, 0x3344, 0x5566, 0x7788, 0x99aa, 0xbbcc, 0xddee, 0xff11);
2650 assert_eq!(Ipv6Addr::from(0x112233445566778899aabbccddeeff11u128), a);
2654 fn ipv4_from_constructors() {
2655 assert_eq!(Ipv4Addr::LOCALHOST, Ipv4Addr::new(127, 0, 0, 1));
2656 assert!(Ipv4Addr::LOCALHOST.is_loopback());
2657 assert_eq!(Ipv4Addr::UNSPECIFIED, Ipv4Addr::new(0, 0, 0, 0));
2658 assert!(Ipv4Addr::UNSPECIFIED.is_unspecified());
2659 assert_eq!(Ipv4Addr::BROADCAST, Ipv4Addr::new(255, 255, 255, 255));
2660 assert!(Ipv4Addr::BROADCAST.is_broadcast());
2664 fn ipv6_from_contructors() {
2665 assert_eq!(Ipv6Addr::LOCALHOST, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
2666 assert!(Ipv6Addr::LOCALHOST.is_loopback());
2667 assert_eq!(Ipv6Addr::UNSPECIFIED, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
2668 assert!(Ipv6Addr::UNSPECIFIED.is_unspecified());
2672 fn ipv4_from_octets() {
2673 assert_eq!(Ipv4Addr::from([127, 0, 0, 1]), Ipv4Addr::new(127, 0, 0, 1))
2677 fn ipv6_from_segments() {
2679 Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2680 let new = Ipv6Addr::new(0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff);
2681 assert_eq!(new, from_u16s);
2685 fn ipv6_from_octets() {
2687 Ipv6Addr::from([0x0011, 0x2233, 0x4455, 0x6677, 0x8899, 0xaabb, 0xccdd, 0xeeff]);
2688 let from_u8s = Ipv6Addr::from([
2689 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd,
2692 assert_eq!(from_u16s, from_u8s);
2697 let v41 = Ipv4Addr::new(100, 64, 3, 3);
2698 let v42 = Ipv4Addr::new(192, 0, 2, 2);
2699 let v61 = "2001:db8:f00::1002".parse::<Ipv6Addr>().unwrap();
2700 let v62 = "2001:db8:f00::2001".parse::<Ipv6Addr>().unwrap();
2704 assert_eq!(v41, IpAddr::V4(v41));
2705 assert_eq!(v61, IpAddr::V6(v61));
2706 assert!(v41 != IpAddr::V4(v42));
2707 assert!(v61 != IpAddr::V6(v62));
2709 assert!(v41 < IpAddr::V4(v42));
2710 assert!(v61 < IpAddr::V6(v62));
2711 assert!(IpAddr::V4(v41) < v42);
2712 assert!(IpAddr::V6(v61) < v62);
2714 assert!(v41 < IpAddr::V6(v61));
2715 assert!(IpAddr::V4(v41) < v61);
2720 let ip = IpAddr::V4(Ipv4Addr::new(100, 64, 3, 3));
2721 assert!(ip.is_ipv4());
2722 assert!(!ip.is_ipv6());
2727 let ip = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0x1234, 0x5678));
2728 assert!(!ip.is_ipv4());
2729 assert!(ip.is_ipv6());