socketaddr: document conversion using From.

tokio-rs · Sep 25, 2024 · f3c5bd3 · f3c5bd3
1 parent beab0c2
commit f3c5bd3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tokio/src/net/unix/socketaddr.rs b/tokio/src/net/unix/socketaddr.rs
@@ -2,6 +2,11 @@ use std::fmt;
 use std::path::Path;
 
 /// An address associated with a Tokio Unix socket.
+///
+/// This type is a think wrapper around
+/// [`std::os::unix::net::SocketAddr`];
+/// you can use [`From`](std::convert::From) to wrap and unwrap
+/// instances of [`std::os::unix::net::SocketAddr`] as this type.
 pub struct SocketAddr(pub(super) std::os::unix::net::SocketAddr);
 
 impl SocketAddr {