Skip to content

Commit 577677d

Browse files
committed
Expanded std::net module docs
Part of rust-lang#29363
1 parent 597bcec commit 577677d

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

src/libstd/net/mod.rs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,32 @@
99
// except according to those terms.
1010

1111
//! Networking primitives for TCP/UDP communication.
12+
//!
13+
//! This module provides networking functionality for the Transmission Control and User
14+
//! Datagram Protocols, as well as types for IP and socket addresses.
15+
//!
16+
//! # Organization
17+
//!
18+
//! * [`TcpListener`] and [`TcpStream`] provide functionality for communication over TCP
19+
//! * [`UdpSocket`] provides functionality for communication over UDP
20+
//! * [`IpAddr`] represents IP addresses of either IPv4 or IPv6; [`Ipv4Addr`] and
21+
//! [`Ipv6Addr`] are respectively IPv4 and IPv6 addresses
22+
//! * [`SocketAddr`] represents socket addresses of either IPv4 or IPv6; [`SocketAddrV4`]
23+
//! and [`SocketAddrV6`] are respectively IPv4 and IPv6 socket addresses
24+
//! * [`ToSocketAddr`] is a trait that used for generic address resolution interacting
25+
//! with networking objects like [`TcpListener`], [`TcpStream`] or [`UdpSocket`]
26+
//! * Other types are return or parameter types for various methods in this module
27+
//!
28+
//! [`IpAddr`]: ../../std/net/enum.IpAddr.html
29+
//! [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
30+
//! [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
31+
//! [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
32+
//! [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
33+
//! [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
34+
//! [`TcpListener`]: ../../std/net/struct.TcpListener.html
35+
//! [`TcpStream`]: ../../std/net/struct.TcpStream.html
36+
//! [`ToSocketAddr`]: ../../std/net/trait.ToSocketAddr.html
37+
//! [`UdpSocket`]: ../../std/net/struct.UdpSocket.html
1238
1339
#![stable(feature = "rust1", since = "1.0.0")]
1440

0 commit comments

Comments
 (0)