1 //! Networking primitives for TCP/UDP communication.
3 //! This module provides networking functionality for the Transmission Control and User
4 //! Datagram Protocols, as well as types for IP and socket addresses.
8 //! * [`TcpListener`] and [`TcpStream`] provide functionality for communication over TCP
9 //! * [`UdpSocket`] provides functionality for communication over UDP
10 //! * [`IpAddr`] represents IP addresses of either IPv4 or IPv6; [`Ipv4Addr`] and
11 //! [`Ipv6Addr`] are respectively IPv4 and IPv6 addresses
12 //! * [`SocketAddr`] represents socket addresses of either IPv4 or IPv6; [`SocketAddrV4`]
13 //! and [`SocketAddrV6`] are respectively IPv4 and IPv6 socket addresses
14 //! * [`ToSocketAddrs`] is a trait that is used for generic address resolution when interacting
15 //! with networking objects like [`TcpListener`], [`TcpStream`] or [`UdpSocket`]
16 //! * Other types are return or parameter types for various methods in this module
18 //! Rust disables inheritance of socket objects to child processes by default when possible. For
19 //! example, through the use of the `CLOEXEC` flag in UNIX systems or the `HANDLE_FLAG_INHERIT`
22 #![stable(feature = "rust1", since = "1.0.0")]
24 use crate::io::{self, ErrorKind};
26 #[stable(feature = "rust1", since = "1.0.0")]
27 pub use self::ip_addr::{IpAddr, Ipv4Addr, Ipv6Addr, Ipv6MulticastScope};
28 #[stable(feature = "rust1", since = "1.0.0")]
29 pub use self::parser::AddrParseError;
30 #[stable(feature = "rust1", since = "1.0.0")]
31 pub use self::socket_addr::{SocketAddr, SocketAddrV4, SocketAddrV6, ToSocketAddrs};
32 #[unstable(feature = "tcplistener_into_incoming", issue = "88339")]
33 pub use self::tcp::IntoIncoming;
34 #[stable(feature = "rust1", since = "1.0.0")]
35 pub use self::tcp::{Incoming, TcpListener, TcpStream};
36 #[stable(feature = "rust1", since = "1.0.0")]
37 pub use self::udp::UdpSocket;
48 /// Possible values which can be passed to the [`TcpStream::shutdown`] method.
49 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
50 #[stable(feature = "rust1", since = "1.0.0")]
52 /// The reading portion of the [`TcpStream`] should be shut down.
54 /// All currently blocked and future [reads] will return <code>[Ok]\(0)</code>.
56 /// [reads]: crate::io::Read "io::Read"
57 #[stable(feature = "rust1", since = "1.0.0")]
59 /// The writing portion of the [`TcpStream`] should be shut down.
61 /// All currently blocked and future [writes] will return an error.
63 /// [writes]: crate::io::Write "io::Write"
64 #[stable(feature = "rust1", since = "1.0.0")]
66 /// Both the reading and the writing portions of the [`TcpStream`] should be shut down.
68 /// See [`Shutdown::Read`] and [`Shutdown::Write`] for more information.
69 #[stable(feature = "rust1", since = "1.0.0")]
73 fn each_addr<A: ToSocketAddrs, F, T>(addr: A, mut f: F) -> io::Result<T>
75 F: FnMut(io::Result<&SocketAddr>) -> io::Result<T>,
77 let addrs = match addr.to_socket_addrs() {
79 Err(e) => return f(Err(e)),
81 let mut last_err = None;
84 Ok(l) => return Ok(l),
85 Err(e) => last_err = Some(e),
88 Err(last_err.unwrap_or_else(|| {
89 io::const_io_error!(ErrorKind::InvalidInput, "could not resolve to any addresses")