about summary refs log tree commit diff
path: root/src/libstd/net
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2018-09-18 10:21:33 +0200
committerGitHub <noreply@github.com>2018-09-18 10:21:33 +0200
commit3cdebfb010291a3293c27b5831fd2444cc3a7c49 (patch)
tree759ccf696102ecb31a52b1b3ae6f1571edf802f2 /src/libstd/net
parentb80cb47889e0ad9400b6708ce2b4c4b364b71982 (diff)
parent4ced4f339599d1f2f137cb23b9b1c4aeb081e200 (diff)
downloadrust-3cdebfb010291a3293c27b5831fd2444cc3a7c49.tar.gz
rust-3cdebfb010291a3293c27b5831fd2444cc3a7c49.zip
Rollup merge of #53522 - phungleson:fix-impl-from-for-addr, r=TimNN
Add doc for impl From for Addr

As part of issue #51430 (cc @skade).

The impl is very simple, let me know if we need to go into any details.

Additionally, I added `#[inline]` for the conversion method, let me know if it is un-necessary or might break something.
Diffstat (limited to 'src/libstd/net')
-rw-r--r--src/libstd/net/addr.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/libstd/net/addr.rs b/src/libstd/net/addr.rs
index e80c3eeb876..ff35325ab4f 100644
--- a/src/libstd/net/addr.rs
+++ b/src/libstd/net/addr.rs
@@ -554,6 +554,7 @@ impl FromInner<c::sockaddr_in6> for SocketAddrV6 {
 
 #[stable(feature = "ip_from_ip", since = "1.16.0")]
 impl From<SocketAddrV4> for SocketAddr {
+    /// Converts a [`SocketAddrV4`] into a [`SocketAddr::V4`].
     fn from(sock4: SocketAddrV4) -> SocketAddr {
         SocketAddr::V4(sock4)
     }
@@ -561,6 +562,7 @@ impl From<SocketAddrV4> for SocketAddr {
 
 #[stable(feature = "ip_from_ip", since = "1.16.0")]
 impl From<SocketAddrV6> for SocketAddr {
+    /// Converts a [`SocketAddrV6`] into a [`SocketAddr::V6`].
     fn from(sock6: SocketAddrV6) -> SocketAddr {
         SocketAddr::V6(sock6)
     }
@@ -568,6 +570,12 @@ impl From<SocketAddrV6> for SocketAddr {
 
 #[stable(feature = "addr_from_into_ip", since = "1.17.0")]
 impl<I: Into<IpAddr>> From<(I, u16)> for SocketAddr {
+    /// Converts a tuple struct (Into<[`IpAddr`]>, `u16`) into a [`SocketAddr`].
+    ///
+    /// This conversion creates a [`SocketAddr::V4`] for a [`IpAddr::V4`]
+    /// and creates a [`SocketAddr::V6`] for a [`IpAddr::V6`].
+    ///
+    /// `u16` is treated as port of the newly created [`SocketAddr`].
     fn from(pieces: (I, u16)) -> SocketAddr {
         SocketAddr::new(pieces.0.into(), pieces.1)
     }