add a note for Ipv4Addr::to_ipv6_compatible

rust-lang · Sep 2, 2020 · 3b29913 · 3b29913
1 parent b4acb11
commit 3b29913
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/library/std/src/net/ip.rs b/library/std/src/net/ip.rs
@@ -745,6 +745,9 @@ impl Ipv4Addr {
     ///
     /// a.b.c.d becomes ::a.b.c.d
     ///
+    /// This isn't typically the method you want; these addresses don't typically
+    /// function on modern systems. Use `to_ipv6_mapped` instead.
+    ///
     /// [`IPv6` address]: Ipv6Addr
     ///
     /// # Examples