|
9 | 9 | // except according to those terms.
|
10 | 10 |
|
11 | 11 | //! 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 |
12 | 38 |
|
13 | 39 | #![stable(feature = "rust1", since = "1.0.0")]
|
14 | 40 |
|
|
0 commit comments