about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDylan DPC <dylan.dpc@gmail.com>2021-04-17 22:31:34 +0200
committerGitHub <noreply@github.com>2021-04-17 22:31:34 +0200
commita3277e2a0a2ccd165f5ea7dd485828051d31e030 (patch)
tree616d2690233fbf51f379942dd30ad591bac178c1
parentd919a5a8f88ba4e045d8b70c4f8890f423bd6013 (diff)
parent9aa4d068a10ea03dffc349485456ae342667a142 (diff)
downloadrust-a3277e2a0a2ccd165f5ea7dd485828051d31e030.tar.gz
rust-a3277e2a0a2ccd165f5ea7dd485828051d31e030.zip
Rollup merge of #84257 - joshtriplett:inaddr-any, r=m-ou-se
Add documentation to help people find `Ipv4Addr::UNSPECIFIED`

People looking for `INADDR_ANY` don't always find `Ipv4Addr::UNSPECIFIED`;
add some documentation to help.
-rw-r--r--library/std/src/net/ip.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/library/std/src/net/ip.rs b/library/std/src/net/ip.rs
index da2415e3610..9b629e19be5 100644
--- a/library/std/src/net/ip.rs
+++ b/library/std/src/net/ip.rs
@@ -334,6 +334,8 @@ impl Ipv4Addr {
 
     /// An IPv4 address representing an unspecified address: 0.0.0.0
     ///
+    /// This corresponds to the constant `INADDR_ANY` in other languages.
+    ///
     /// # Examples
     ///
     /// ```
@@ -342,6 +344,7 @@ impl Ipv4Addr {
     /// let addr = Ipv4Addr::UNSPECIFIED;
     /// assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));
     /// ```
+    #[doc(alias = "INADDR_ANY")]
     #[stable(feature = "ip_constructors", since = "1.30.0")]
     pub const UNSPECIFIED: Self = Ipv4Addr::new(0, 0, 0, 0);