mirror of
https://github.com/rust-lang/rust.git
synced 2025-02-03 18:43:38 +00:00
Auto merge of #75567 - poliorcetics:intra-links-std-net, r=jyn514
Move to intra doc links in std::net Helps with #75080. @rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc The links for `true` and `false` had to stay else `rustdoc` complained, it is intended ?
This commit is contained in:
bors
commit
7a4fb355c6
@ -22,9 +22,7 @@ use crate::vec;
|
||||
/// The size of a `SocketAddr` instance may vary depending on the target operating
|
||||
/// system.
|
||||
///
|
||||
/// [IP address]: ../../std/net/enum.IpAddr.html
|
||||
/// [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
|
||||
/// [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
|
||||
/// [IP address]: IpAddr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -50,7 +48,7 @@ pub enum SocketAddr {
|
||||
|
||||
/// An IPv4 socket address.
|
||||
///
|
||||
/// IPv4 socket addresses consist of an [IPv4 address] and a 16-bit port number, as
|
||||
/// IPv4 socket addresses consist of an [`IPv4` address] and a 16-bit port number, as
|
||||
/// stated in [IETF RFC 793].
|
||||
///
|
||||
/// See [`SocketAddr`] for a type encompassing both IPv4 and IPv6 socket addresses.
|
||||
@ -59,8 +57,7 @@ pub enum SocketAddr {
|
||||
/// system.
|
||||
///
|
||||
/// [IETF RFC 793]: https://tools.ietf.org/html/rfc793
|
||||
/// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
|
||||
/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
/// [`IPv4` address]: Ipv4Addr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -81,7 +78,7 @@ pub struct SocketAddrV4 {
|
||||
|
||||
/// An IPv6 socket address.
|
||||
///
|
||||
/// IPv6 socket addresses consist of an [Ipv6 address], a 16-bit port number, as well
|
||||
/// IPv6 socket addresses consist of an [`IPv6` address], a 16-bit port number, as well
|
||||
/// as fields containing the traffic class, the flow label, and a scope identifier
|
||||
/// (see [IETF RFC 2553, Section 3.3] for more details).
|
||||
///
|
||||
@ -91,8 +88,7 @@ pub struct SocketAddrV4 {
|
||||
/// system.
|
||||
///
|
||||
/// [IETF RFC 2553, Section 3.3]: https://tools.ietf.org/html/rfc2553#section-3.3
|
||||
/// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
|
||||
/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
/// [`IPv6` address]: Ipv6Addr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -114,7 +110,7 @@ pub struct SocketAddrV6 {
|
||||
impl SocketAddr {
|
||||
/// Creates a new socket address from an [IP address] and a port number.
|
||||
///
|
||||
/// [IP address]: ../../std/net/enum.IpAddr.html
|
||||
/// [IP address]: IpAddr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -210,12 +206,12 @@ impl SocketAddr {
|
||||
}
|
||||
|
||||
/// Returns [`true`] if the [IP address] in this `SocketAddr` is an
|
||||
/// [IPv4 address], and [`false`] otherwise.
|
||||
/// [`IPv4` address], and [`false`] otherwise.
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IP address]: IpAddr
|
||||
/// [`IPv4` address]: IpAddr::V4
|
||||
/// [`false`]: ../../std/primitive.bool.html
|
||||
/// [IP address]: ../../std/net/enum.IpAddr.html
|
||||
/// [IPv4 address]: ../../std/net/enum.IpAddr.html#variant.V4
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -232,12 +228,12 @@ impl SocketAddr {
|
||||
}
|
||||
|
||||
/// Returns [`true`] if the [IP address] in this `SocketAddr` is an
|
||||
/// [IPv6 address], and [`false`] otherwise.
|
||||
/// [`IPv6` address], and [`false`] otherwise.
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IP address]: IpAddr
|
||||
/// [`IPv6` address]: IpAddr::V6
|
||||
/// [`false`]: ../../std/primitive.bool.html
|
||||
/// [IP address]: ../../std/net/enum.IpAddr.html
|
||||
/// [IPv6 address]: ../../std/net/enum.IpAddr.html#variant.V6
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -255,9 +251,9 @@ impl SocketAddr {
|
||||
}
|
||||
|
||||
impl SocketAddrV4 {
|
||||
/// Creates a new socket address from an [IPv4 address] and a port number.
|
||||
/// Creates a new socket address from an [`IPv4` address] and a port number.
|
||||
///
|
||||
/// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
|
||||
/// [`IPv4` address]: Ipv4Addr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -342,14 +338,14 @@ impl SocketAddrV4 {
|
||||
}
|
||||
|
||||
impl SocketAddrV6 {
|
||||
/// Creates a new socket address from an [IPv6 address], a 16-bit port number,
|
||||
/// Creates a new socket address from an [`IPv6` address], a 16-bit port number,
|
||||
/// and the `flowinfo` and `scope_id` fields.
|
||||
///
|
||||
/// For more information on the meaning and layout of the `flowinfo` and `scope_id`
|
||||
/// parameters, see [IETF RFC 2553, Section 3.3].
|
||||
///
|
||||
/// [IETF RFC 2553, Section 3.3]: https://tools.ietf.org/html/rfc2553#section-3.3
|
||||
/// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
|
||||
/// [`IPv6` address]: Ipv6Addr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -461,9 +457,7 @@ impl SocketAddrV6 {
|
||||
|
||||
/// Changes the flow information associated with this socket address.
|
||||
///
|
||||
/// See the [`flowinfo`] method's documentation for more details.
|
||||
///
|
||||
/// [`flowinfo`]: #method.flowinfo
|
||||
/// See [`SocketAddrV6::flowinfo`]'s documentation for more details.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -501,9 +495,7 @@ impl SocketAddrV6 {
|
||||
|
||||
/// Changes the scope ID associated with this socket address.
|
||||
///
|
||||
/// See the [`scope_id`] method's documentation for more details.
|
||||
///
|
||||
/// [`scope_id`]: #method.scope_id
|
||||
/// See [`SocketAddrV6::scope_id`]'s documentation for more details.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -535,9 +527,6 @@ 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`].
|
||||
///
|
||||
/// [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
|
||||
/// [`SocketAddr::V4`]: ../../std/net/enum.SocketAddr.html#variant.V4
|
||||
fn from(sock4: SocketAddrV4) -> SocketAddr {
|
||||
SocketAddr::V4(sock4)
|
||||
}
|
||||
@ -546,9 +535,6 @@ 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`].
|
||||
///
|
||||
/// [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
|
||||
/// [`SocketAddr::V6`]: ../../std/net/enum.SocketAddr.html#variant.V6
|
||||
fn from(sock6: SocketAddrV6) -> SocketAddr {
|
||||
SocketAddr::V6(sock6)
|
||||
}
|
||||
@ -562,13 +548,6 @@ impl<I: Into<IpAddr>> From<(I, u16)> for SocketAddr {
|
||||
/// and creates a [`SocketAddr::V6`] for a [`IpAddr::V6`].
|
||||
///
|
||||
/// `u16` is treated as port of the newly created [`SocketAddr`].
|
||||
///
|
||||
/// [`IpAddr`]: ../../std/net/enum.IpAddr.html
|
||||
/// [`IpAddr::V4`]: ../../std/net/enum.IpAddr.html#variant.V4
|
||||
/// [`IpAddr::V6`]: ../../std/net/enum.IpAddr.html#variant.V6
|
||||
/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
/// [`SocketAddr::V4`]: ../../std/net/enum.SocketAddr.html#variant.V4
|
||||
/// [`SocketAddr::V6`]: ../../std/net/enum.SocketAddr.html#variant.V6
|
||||
fn from(pieces: (I, u16)) -> SocketAddr {
|
||||
SocketAddr::new(pieces.0.into(), pieces.1)
|
||||
}
|
||||
@ -785,18 +764,11 @@ impl hash::Hash for SocketAddrV6 {
|
||||
/// Addresses returned by the operating system that are not IP addresses are
|
||||
/// silently ignored.
|
||||
///
|
||||
/// [`FromStr`]: ../../std/str/trait.FromStr.html
|
||||
/// [`IpAddr`]: ../../std/net/enum.IpAddr.html
|
||||
/// [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
|
||||
/// [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
|
||||
/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
/// [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
|
||||
/// [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
|
||||
/// [`&str`]: ../../std/primitive.str.html
|
||||
/// [`TcpStream`]: ../../std/net/struct.TcpStream.html
|
||||
/// [`to_socket_addrs`]: #tymethod.to_socket_addrs
|
||||
/// [`UdpSocket`]: ../../std/net/struct.UdpSocket.html
|
||||
/// [`u16`]: ../../std/primitive.u16.html
|
||||
/// [`FromStr`]: crate::str::FromStr
|
||||
/// [`&str`]: str
|
||||
/// [`TcpStream`]: crate::net::TcpStream
|
||||
/// [`to_socket_addrs`]: ToSocketAddrs::to_socket_addrs
|
||||
/// [`UdpSocket`]: crate::net::UdpSocket
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -867,7 +839,7 @@ impl hash::Hash for SocketAddrV6 {
|
||||
/// let stream = TcpStream::connect((Ipv4Addr::new(127, 0, 0, 1), 443));
|
||||
/// ```
|
||||
///
|
||||
/// [`TcpStream::connect`]: ../../std/net/struct.TcpStream.html#method.connect
|
||||
/// [`TcpStream::connect`]: crate::net::TcpStream::connect
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub trait ToSocketAddrs {
|
||||
/// Returned iterator over socket addresses which this type may correspond
|
||||
|
||||
@ -22,9 +22,6 @@ use crate::sys_common::{AsInner, FromInner};
|
||||
/// The size of an `IpAddr` instance may vary depending on the target operating
|
||||
/// system.
|
||||
///
|
||||
/// [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
|
||||
/// [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
@ -61,14 +58,13 @@ pub enum IpAddr {
|
||||
/// system.
|
||||
///
|
||||
/// [IETF RFC 791]: https://tools.ietf.org/html/rfc791
|
||||
/// [`IpAddr`]: ../../std/net/enum.IpAddr.html
|
||||
///
|
||||
/// # Textual representation
|
||||
///
|
||||
/// `Ipv4Addr` provides a [`FromStr`] implementation. The four octets are in decimal
|
||||
/// notation, divided by `.` (this is called "dot-decimal notation").
|
||||
///
|
||||
/// [`FromStr`]: ../../std/str/trait.FromStr.html
|
||||
/// [`FromStr`]: crate::str::FromStr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -96,7 +92,6 @@ pub struct Ipv4Addr {
|
||||
/// system.
|
||||
///
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
/// [`IpAddr`]: ../../std/net/enum.IpAddr.html
|
||||
///
|
||||
/// # Textual representation
|
||||
///
|
||||
@ -105,7 +100,7 @@ pub struct Ipv4Addr {
|
||||
/// notation, and segments are separated by `:`. For more information, see
|
||||
/// [IETF RFC 5952].
|
||||
///
|
||||
/// [`FromStr`]: ../../std/str/trait.FromStr.html
|
||||
/// [`FromStr`]: crate::str::FromStr
|
||||
/// [IETF RFC 5952]: https://tools.ietf.org/html/rfc5952
|
||||
///
|
||||
/// # Examples
|
||||
@ -138,11 +133,9 @@ pub enum Ipv6MulticastScope {
|
||||
impl IpAddr {
|
||||
/// Returns [`true`] for the special 'unspecified' address.
|
||||
///
|
||||
/// See the documentation for [`Ipv4Addr::is_unspecified`][IPv4] and
|
||||
/// [`Ipv6Addr::is_unspecified`][IPv6] for more details.
|
||||
/// See the documentation for [`Ipv4Addr::is_unspecified()`] and
|
||||
/// [`Ipv6Addr::is_unspecified()`] for more details.
|
||||
///
|
||||
/// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_unspecified
|
||||
/// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_unspecified
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
@ -163,11 +156,9 @@ impl IpAddr {
|
||||
|
||||
/// Returns [`true`] if this is a loopback address.
|
||||
///
|
||||
/// See the documentation for [`Ipv4Addr::is_loopback`][IPv4] and
|
||||
/// [`Ipv6Addr::is_loopback`][IPv6] for more details.
|
||||
/// See the documentation for [`Ipv4Addr::is_loopback()`] and
|
||||
/// [`Ipv6Addr::is_loopback()`] for more details.
|
||||
///
|
||||
/// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_loopback
|
||||
/// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_loopback
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
@ -188,11 +179,9 @@ impl IpAddr {
|
||||
|
||||
/// Returns [`true`] if the address appears to be globally routable.
|
||||
///
|
||||
/// See the documentation for [`Ipv4Addr::is_global`][IPv4] and
|
||||
/// [`Ipv6Addr::is_global`][IPv6] for more details.
|
||||
/// See the documentation for [`Ipv4Addr::is_global()`] and
|
||||
/// [`Ipv6Addr::is_global()`] for more details.
|
||||
///
|
||||
/// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_global
|
||||
/// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_global
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
@ -214,11 +203,9 @@ impl IpAddr {
|
||||
|
||||
/// Returns [`true`] if this is a multicast address.
|
||||
///
|
||||
/// See the documentation for [`Ipv4Addr::is_multicast`][IPv4] and
|
||||
/// [`Ipv6Addr::is_multicast`][IPv6] for more details.
|
||||
/// See the documentation for [`Ipv4Addr::is_multicast()`] and
|
||||
/// [`Ipv6Addr::is_multicast()`] for more details.
|
||||
///
|
||||
/// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_multicast
|
||||
/// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_multicast
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
@ -239,11 +226,9 @@ impl IpAddr {
|
||||
|
||||
/// Returns [`true`] if this address is in a range designated for documentation.
|
||||
///
|
||||
/// See the documentation for [`Ipv4Addr::is_documentation`][IPv4] and
|
||||
/// [`Ipv6Addr::is_documentation`][IPv6] for more details.
|
||||
/// See the documentation for [`Ipv4Addr::is_documentation()`] and
|
||||
/// [`Ipv6Addr::is_documentation()`] for more details.
|
||||
///
|
||||
/// [IPv4]: ../../std/net/struct.Ipv4Addr.html#method.is_documentation
|
||||
/// [IPv6]: ../../std/net/struct.Ipv6Addr.html#method.is_documentation
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
@ -266,11 +251,12 @@ impl IpAddr {
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns [`true`] if this address is an [IPv4 address], and [`false`] otherwise.
|
||||
/// Returns [`true`] if this address is an [`IPv4` address], and [`false`]
|
||||
/// otherwise.
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [`false`]: ../../std/primitive.bool.html
|
||||
/// [IPv4 address]: #variant.V4
|
||||
/// [`IPv4` address]: IpAddr::V4
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -285,11 +271,12 @@ impl IpAddr {
|
||||
matches!(self, IpAddr::V4(_))
|
||||
}
|
||||
|
||||
/// Returns [`true`] if this address is an [IPv6 address], and [`false`] otherwise.
|
||||
/// Returns [`true`] if this address is an [`IPv6` address], and [`false`]
|
||||
/// otherwise.
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [`false`]: ../../std/primitive.bool.html
|
||||
/// [IPv6 address]: #variant.V6
|
||||
/// [`IPv6` address]: IpAddr::V6
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -385,8 +372,8 @@ impl Ipv4Addr {
|
||||
/// This property is defined in _UNIX Network Programming, Second Edition_,
|
||||
/// W. Richard Stevens, p. 891; see also [ip7].
|
||||
///
|
||||
/// [ip7]: http://man7.org/linux/man-pages/man7/ip.7.html
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [ip7]: http://man7.org/linux/man-pages/man7/ip.7.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -406,8 +393,8 @@ impl Ipv4Addr {
|
||||
///
|
||||
/// This property is defined by [IETF RFC 1122].
|
||||
///
|
||||
/// [IETF RFC 1122]: https://tools.ietf.org/html/rfc1122
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 1122]: https://tools.ietf.org/html/rfc1122
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -430,8 +417,8 @@ impl Ipv4Addr {
|
||||
/// - 172.16.0.0/12
|
||||
/// - 192.168.0.0/16
|
||||
///
|
||||
/// [IETF RFC 1918]: https://tools.ietf.org/html/rfc1918
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 1918]: https://tools.ietf.org/html/rfc1918
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -460,8 +447,8 @@ impl Ipv4Addr {
|
||||
///
|
||||
/// This property is defined by [IETF RFC 3927].
|
||||
///
|
||||
/// [IETF RFC 3927]: https://tools.ietf.org/html/rfc3927
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 3927]: https://tools.ietf.org/html/rfc3927
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -483,24 +470,25 @@ impl Ipv4Addr {
|
||||
/// Returns [`true`] if the address appears to be globally routable.
|
||||
/// See [iana-ipv4-special-registry][ipv4-sr].
|
||||
///
|
||||
/// The following return false:
|
||||
/// The following return [`false`]:
|
||||
///
|
||||
/// - private addresses (see [`is_private()`](#method.is_private))
|
||||
/// - the loopback address (see [`is_loopback()`](#method.is_loopback))
|
||||
/// - the link-local address (see [`is_link_local()`](#method.is_link_local))
|
||||
/// - the broadcast address (see [`is_broadcast()`](#method.is_broadcast))
|
||||
/// - addresses used for documentation (see [`is_documentation()`](#method.is_documentation))
|
||||
/// - the unspecified address (see [`is_unspecified()`](#method.is_unspecified)), and the whole
|
||||
/// - private addresses (see [`Ipv4Addr::is_private()`])
|
||||
/// - the loopback address (see [`Ipv4Addr::is_loopback()`])
|
||||
/// - the link-local address (see [`Ipv4Addr::is_link_local()`])
|
||||
/// - the broadcast address (see [`Ipv4Addr::is_broadcast()`])
|
||||
/// - addresses used for documentation (see [`Ipv4Addr::is_documentation()`])
|
||||
/// - the unspecified address (see [`Ipv4Addr::is_unspecified()`]), and the whole
|
||||
/// 0.0.0.0/8 block
|
||||
/// - addresses reserved for future protocols (see
|
||||
/// [`is_ietf_protocol_assignment()`](#method.is_ietf_protocol_assignment), except
|
||||
/// [`Ipv4Addr::is_ietf_protocol_assignment()`], except
|
||||
/// `192.0.0.9/32` and `192.0.0.10/32` which are globally routable
|
||||
/// - addresses reserved for future use (see [`is_reserved()`](#method.is_reserved)
|
||||
/// - addresses reserved for future use (see [`Ipv4Addr::is_reserved()`]
|
||||
/// - addresses reserved for networking devices benchmarking (see
|
||||
/// [`is_benchmarking`](#method.is_benchmarking))
|
||||
/// [`Ipv4Addr::is_benchmarking()`])
|
||||
///
|
||||
/// [ipv4-sr]: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [`false`]: ../../std/primitive.bool.html
|
||||
/// [ipv4-sr]: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -572,8 +560,8 @@ impl Ipv4Addr {
|
||||
/// Returns [`true`] if this address is part of the Shared Address Space defined in
|
||||
/// [IETF RFC 6598] (`100.64.0.0/10`).
|
||||
///
|
||||
/// [IETF RFC 6598]: https://tools.ietf.org/html/rfc6598
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 6598]: https://tools.ietf.org/html/rfc6598
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -598,11 +586,11 @@ impl Ipv4Addr {
|
||||
/// - `192.0.0.9/32` is the "Port Control Protocol Anycast" (see [IETF RFC 7723])
|
||||
/// - `192.0.0.10/32` is used for NAT traversal (see [IETF RFC 8155])
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 6890]: https://tools.ietf.org/html/rfc6890
|
||||
/// [IETF RFC 7600]: https://tools.ietf.org/html/rfc7600
|
||||
/// [IETF RFC 7723]: https://tools.ietf.org/html/rfc7723
|
||||
/// [IETF RFC 8155]: https://tools.ietf.org/html/rfc8155
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -625,9 +613,9 @@ impl Ipv4Addr {
|
||||
/// network devices benchmarking. This range is defined in [IETF RFC 2544] as `192.18.0.0`
|
||||
/// through `198.19.255.255` but [errata 423] corrects it to `198.18.0.0/15`.
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 2544]: https://tools.ietf.org/html/rfc2544
|
||||
/// [errata 423]: https://www.rfc-editor.org/errata/eid423
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -649,8 +637,8 @@ impl Ipv4Addr {
|
||||
/// broadcast address `255.255.255.255`, but this implementation explicitly excludes it, since
|
||||
/// it is obviously not reserved for future use.
|
||||
///
|
||||
/// [IETF RFC 1112]: https://tools.ietf.org/html/rfc1112
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 1112]: https://tools.ietf.org/html/rfc1112
|
||||
///
|
||||
/// # Warning
|
||||
///
|
||||
@ -681,8 +669,8 @@ impl Ipv4Addr {
|
||||
/// Multicast addresses have a most significant octet between 224 and 239,
|
||||
/// and is defined by [IETF RFC 5771].
|
||||
///
|
||||
/// [IETF RFC 5771]: https://tools.ietf.org/html/rfc5771
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 5771]: https://tools.ietf.org/html/rfc5771
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -702,8 +690,8 @@ impl Ipv4Addr {
|
||||
///
|
||||
/// A broadcast address has all octets set to 255 as defined in [IETF RFC 919].
|
||||
///
|
||||
/// [IETF RFC 919]: https://tools.ietf.org/html/rfc919
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 919]: https://tools.ietf.org/html/rfc919
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -726,8 +714,8 @@ impl Ipv4Addr {
|
||||
/// - 198.51.100.0/24 (TEST-NET-2)
|
||||
/// - 203.0.113.0/24 (TEST-NET-3)
|
||||
///
|
||||
/// [IETF RFC 5737]: https://tools.ietf.org/html/rfc5737
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 5737]: https://tools.ietf.org/html/rfc5737
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -749,11 +737,11 @@ impl Ipv4Addr {
|
||||
}
|
||||
}
|
||||
|
||||
/// Converts this address to an IPv4-compatible [IPv6 address].
|
||||
/// Converts this address to an IPv4-compatible [`IPv6` address].
|
||||
///
|
||||
/// a.b.c.d becomes ::a.b.c.d
|
||||
///
|
||||
/// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
|
||||
/// [`IPv6` address]: Ipv6Addr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -771,11 +759,11 @@ impl Ipv4Addr {
|
||||
Ipv6Addr::from([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, a, b, c, d])
|
||||
}
|
||||
|
||||
/// Converts this address to an IPv4-mapped [IPv6 address].
|
||||
/// Converts this address to an IPv4-mapped [`IPv6` address].
|
||||
///
|
||||
/// a.b.c.d becomes ::ffff:a.b.c.d
|
||||
///
|
||||
/// [IPv6 address]: ../../std/net/struct.Ipv6Addr.html
|
||||
/// [`IPv6` address]: Ipv6Addr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1128,8 +1116,8 @@ impl Ipv6Addr {
|
||||
///
|
||||
/// This property is defined in [IETF RFC 4291].
|
||||
///
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1148,8 +1136,8 @@ impl Ipv6Addr {
|
||||
///
|
||||
/// This property is defined in [IETF RFC 4291].
|
||||
///
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1199,6 +1187,7 @@ impl Ipv6Addr {
|
||||
/// This property is defined in [IETF RFC 4193].
|
||||
///
|
||||
/// [IETF RFC 4193]: https://tools.ietf.org/html/rfc4193
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
@ -1230,7 +1219,9 @@ impl Ipv6Addr {
|
||||
///
|
||||
/// This method validates the format defined in the RFC and won't recognize the following
|
||||
/// addresses such as `fe80:0:0:1::` or `fe81::` as unicast link-local addresses for example.
|
||||
/// If you need a less strict validation use [`is_unicast_link_local()`] instead.
|
||||
/// If you need a less strict validation use [`Ipv6Addr::is_unicast_link_local()`] instead.
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1259,13 +1250,11 @@ impl Ipv6Addr {
|
||||
/// - [IETF RFC 4291 section 2.5.6]
|
||||
/// - [RFC 4291 errata 4406] (which has been rejected but provides useful
|
||||
/// insight)
|
||||
/// - [`is_unicast_link_local()`]
|
||||
/// - [`Ipv6Addr::is_unicast_link_local()`]
|
||||
///
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
/// [IETF RFC 4291 section 2.5.6]: https://tools.ietf.org/html/rfc4291#section-2.5.6
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
|
||||
/// [`is_unicast_link_local()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local
|
||||
pub fn is_unicast_link_local_strict(&self) -> bool {
|
||||
(self.segments()[0] & 0xffff) == 0xfe80
|
||||
&& (self.segments()[1] & 0xffff) == 0
|
||||
@ -1287,9 +1276,11 @@ impl Ipv6Addr {
|
||||
/// ```
|
||||
///
|
||||
/// As a result, this method consider addresses such as `fe80:0:0:1::` or `fe81::` to be
|
||||
/// unicast link-local addresses, whereas [`is_unicast_link_local_strict()`] does not. If you
|
||||
/// need a strict validation fully compliant with the RFC, use
|
||||
/// [`is_unicast_link_local_strict()`].
|
||||
/// unicast link-local addresses, whereas [`Ipv6Addr::is_unicast_link_local_strict()`] does not.
|
||||
/// If you need a strict validation fully compliant with the RFC, use
|
||||
/// [`Ipv6Addr::is_unicast_link_local_strict()`] instead.
|
||||
///
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1320,9 +1311,7 @@ impl Ipv6Addr {
|
||||
/// insight)
|
||||
///
|
||||
/// [IETF RFC 4291 section 2.4]: https://tools.ietf.org/html/rfc4291#section-2.4
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [RFC 4291 errata 4406]: https://www.rfc-editor.org/errata/eid4406
|
||||
/// [`is_unicast_link_local_strict()`]: ../../std/net/struct.Ipv6Addr.html#method.is_unicast_link_local_strict
|
||||
pub fn is_unicast_link_local(&self) -> bool {
|
||||
(self.segments()[0] & 0xffc0) == 0xfe80
|
||||
}
|
||||
@ -1371,8 +1360,8 @@ impl Ipv6Addr {
|
||||
///
|
||||
/// This property is defined in [IETF RFC 3849].
|
||||
///
|
||||
/// [IETF RFC 3849]: https://tools.ietf.org/html/rfc3849
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 3849]: https://tools.ietf.org/html/rfc3849
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1464,8 +1453,8 @@ impl Ipv6Addr {
|
||||
///
|
||||
/// This property is defined by [IETF RFC 4291].
|
||||
///
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
/// [`true`]: ../../std/primitive.bool.html
|
||||
/// [IETF RFC 4291]: https://tools.ietf.org/html/rfc4291
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1480,14 +1469,13 @@ impl Ipv6Addr {
|
||||
(self.segments()[0] & 0xff00) == 0xff00
|
||||
}
|
||||
|
||||
/// Converts this address to an [IPv4 address] if it's an "IPv4-mapped IPv6 address"
|
||||
/// Converts this address to an [`IPv4` address] if it's an "IPv4-mapped IPv6 address"
|
||||
/// defined in [IETF RFC 4291 section 2.5.5.2], otherwise returns [`None`].
|
||||
///
|
||||
/// `::ffff:a.b.c.d` becomes `a.b.c.d`.
|
||||
/// All addresses *not* starting with `::ffff` will return `None`.
|
||||
///
|
||||
/// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`IPv4` address]: Ipv4Addr
|
||||
/// [IETF RFC 4291 section 2.5.5.2]: https://tools.ietf.org/html/rfc4291#section-2.5.5.2
|
||||
///
|
||||
/// # Examples
|
||||
@ -1511,13 +1499,12 @@ impl Ipv6Addr {
|
||||
}
|
||||
}
|
||||
|
||||
/// Converts this address to an [IPv4 address]. Returns [`None`] if this address is
|
||||
/// Converts this address to an [`IPv4` address]. Returns [`None`] if this address is
|
||||
/// neither IPv4-compatible or IPv4-mapped.
|
||||
///
|
||||
/// ::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d
|
||||
///
|
||||
/// [IPv4 address]: ../../std/net/struct.Ipv4Addr.html
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`IPv4` address]: Ipv4Addr
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
|
||||
@ -14,17 +14,6 @@
|
||||
//! * [`ToSocketAddrs`] is a trait that used for generic address resolution when interacting
|
||||
//! with networking objects like [`TcpListener`], [`TcpStream`] or [`UdpSocket`]
|
||||
//! * Other types are return or parameter types for various methods in this module
|
||||
//!
|
||||
//! [`IpAddr`]: ../../std/net/enum.IpAddr.html
|
||||
//! [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
|
||||
//! [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
|
||||
//! [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
//! [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
|
||||
//! [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
|
||||
//! [`TcpListener`]: ../../std/net/struct.TcpListener.html
|
||||
//! [`TcpStream`]: ../../std/net/struct.TcpStream.html
|
||||
//! [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
|
||||
//! [`UdpSocket`]: ../../std/net/struct.UdpSocket.html
|
||||
|
||||
#![stable(feature = "rust1", since = "1.0.0")]
|
||||
|
||||
@ -49,38 +38,27 @@ mod tcp;
|
||||
mod test;
|
||||
mod udp;
|
||||
|
||||
/// Possible values which can be passed to the [`shutdown`] method of
|
||||
/// [`TcpStream`].
|
||||
///
|
||||
/// [`shutdown`]: struct.TcpStream.html#method.shutdown
|
||||
/// [`TcpStream`]: struct.TcpStream.html
|
||||
/// Possible values which can be passed to the [`TcpStream::shutdown`] method.
|
||||
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
pub enum Shutdown {
|
||||
/// The reading portion of the [`TcpStream`] should be shut down.
|
||||
///
|
||||
/// All currently blocked and future [reads] will return [`Ok(0)`].
|
||||
/// All currently blocked and future [reads] will return [`Ok`]`(0)`.
|
||||
///
|
||||
/// [`TcpStream`]: ../../std/net/struct.TcpStream.html
|
||||
/// [reads]: ../../std/io/trait.Read.html
|
||||
/// [`Ok(0)`]: ../../std/result/enum.Result.html#variant.Ok
|
||||
/// [reads]: crate::io::Read
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
Read,
|
||||
/// The writing portion of the [`TcpStream`] should be shut down.
|
||||
///
|
||||
/// All currently blocked and future [writes] will return an error.
|
||||
///
|
||||
/// [`TcpStream`]: ../../std/net/struct.TcpStream.html
|
||||
/// [writes]: ../../std/io/trait.Write.html
|
||||
/// [writes]: crate::io::Write
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
Write,
|
||||
/// Both the reading and the writing portions of the [`TcpStream`] should be shut down.
|
||||
///
|
||||
/// See [`Shutdown::Read`] and [`Shutdown::Write`] for more information.
|
||||
///
|
||||
/// [`TcpStream`]: ../../std/net/struct.TcpStream.html
|
||||
/// [`Shutdown::Read`]: #variant.Read
|
||||
/// [`Shutdown::Write`]: #variant.Write
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
Both,
|
||||
}
|
||||
|
||||
@ -302,14 +302,6 @@ impl FromStr for SocketAddr {
|
||||
/// // No problem, the `panic!` message has disappeared.
|
||||
/// let _foo: SocketAddr = "127.0.0.1:8080".parse().expect("unreachable panic");
|
||||
/// ```
|
||||
///
|
||||
/// [`FromStr`]: ../../std/str/trait.FromStr.html
|
||||
/// [`IpAddr`]: ../../std/net/enum.IpAddr.html
|
||||
/// [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
|
||||
/// [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
|
||||
/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
/// [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
|
||||
/// [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct AddrParseError(());
|
||||
|
||||
@ -20,13 +20,12 @@ use crate::time::Duration;
|
||||
///
|
||||
/// The Transmission Control Protocol is specified in [IETF RFC 793].
|
||||
///
|
||||
/// [`accept`]: ../../std/net/struct.TcpListener.html#method.accept
|
||||
/// [`connect`]: #method.connect
|
||||
/// [`accept`]: TcpListener::accept
|
||||
/// [`connect`]: TcpStream::connect
|
||||
/// [IETF RFC 793]: https://tools.ietf.org/html/rfc793
|
||||
/// [reading]: ../../std/io/trait.Read.html
|
||||
/// [`shutdown`]: #method.shutdown
|
||||
/// [`TcpListener`]: ../../std/net/struct.TcpListener.html
|
||||
/// [writing]: ../../std/io/trait.Write.html
|
||||
/// [reading]: Read
|
||||
/// [`shutdown`]: TcpStream::shutdown
|
||||
/// [writing]: Write
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -55,11 +54,9 @@ pub struct TcpStream(net_imp::TcpStream);
|
||||
///
|
||||
/// The Transmission Control Protocol is specified in [IETF RFC 793].
|
||||
///
|
||||
/// [`accept`]: #method.accept
|
||||
/// [`bind`]: #method.bind
|
||||
/// [`accept`]: TcpListener::accept
|
||||
/// [`bind`]: TcpListener::bind
|
||||
/// [IETF RFC 793]: https://tools.ietf.org/html/rfc793
|
||||
/// [`Incoming`]: ../../std/net/struct.Incoming.html
|
||||
/// [`TcpListener::incoming`]: #method.incoming
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -85,12 +82,10 @@ pub struct TcpListener(net_imp::TcpListener);
|
||||
|
||||
/// An iterator that infinitely [`accept`]s connections on a [`TcpListener`].
|
||||
///
|
||||
/// This `struct` is created by the [`incoming`] method on [`TcpListener`].
|
||||
/// This `struct` is created by the [`TcpListener::incoming`] method.
|
||||
/// See its documentation for more.
|
||||
///
|
||||
/// [`accept`]: ../../std/net/struct.TcpListener.html#method.accept
|
||||
/// [`incoming`]: ../../std/net/struct.TcpListener.html#method.incoming
|
||||
/// [`TcpListener`]: ../../std/net/struct.TcpListener.html
|
||||
/// [`accept`]: TcpListener::accept
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
#[derive(Debug)]
|
||||
pub struct Incoming<'a> {
|
||||
@ -109,8 +104,6 @@ impl TcpStream {
|
||||
/// the addresses result in a successful connection, the error returned from
|
||||
/// the last connection attempt (the last address) is returned.
|
||||
///
|
||||
/// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Open a TCP connection to `127.0.0.1:8080`:
|
||||
@ -157,8 +150,6 @@ impl TcpStream {
|
||||
/// single system call. It instead calls `connect` in nonblocking mode and
|
||||
/// then uses an OS-specific mechanism to await the completion of the
|
||||
/// connection request.
|
||||
///
|
||||
/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
#[stable(feature = "tcpstream_connect_timeout", since = "1.21.0")]
|
||||
pub fn connect_timeout(addr: &SocketAddr, timeout: Duration) -> io::Result<TcpStream> {
|
||||
net_imp::TcpStream::connect_timeout(addr, timeout).map(TcpStream)
|
||||
@ -204,8 +195,6 @@ impl TcpStream {
|
||||
/// portions to return immediately with an appropriate value (see the
|
||||
/// documentation of [`Shutdown`]).
|
||||
///
|
||||
/// [`Shutdown`]: ../../std/net/enum.Shutdown.html
|
||||
///
|
||||
/// # Platform-specific behavior
|
||||
///
|
||||
/// Calling this function multiple times may result in different behavior,
|
||||
@ -260,12 +249,9 @@ impl TcpStream {
|
||||
/// a result of setting this option. For example Unix typically returns an
|
||||
/// error of the kind [`WouldBlock`], but Windows may return [`TimedOut`].
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`Err`]: ../../std/result/enum.Result.html#variant.Err
|
||||
/// [`read`]: ../../std/io/trait.Read.html#tymethod.read
|
||||
/// [`WouldBlock`]: ../../std/io/enum.ErrorKind.html#variant.WouldBlock
|
||||
/// [`TimedOut`]: ../../std/io/enum.ErrorKind.html#variant.TimedOut
|
||||
/// [`Duration`]: ../../std/time/struct.Duration.html
|
||||
/// [`read`]: Read::read
|
||||
/// [`WouldBlock`]: io::ErrorKind::WouldBlock
|
||||
/// [`TimedOut`]: io::ErrorKind::TimedOut
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -307,12 +293,9 @@ impl TcpStream {
|
||||
/// as a result of setting this option. For example Unix typically returns
|
||||
/// an error of the kind [`WouldBlock`], but Windows may return [`TimedOut`].
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`Err`]: ../../std/result/enum.Result.html#variant.Err
|
||||
/// [`write`]: ../../std/io/trait.Write.html#tymethod.write
|
||||
/// [`Duration`]: ../../std/time/struct.Duration.html
|
||||
/// [`WouldBlock`]: ../../std/io/enum.ErrorKind.html#variant.WouldBlock
|
||||
/// [`TimedOut`]: ../../std/io/enum.ErrorKind.html#variant.TimedOut
|
||||
/// [`write`]: Write::write
|
||||
/// [`WouldBlock`]: io::ErrorKind::WouldBlock
|
||||
/// [`TimedOut`]: io::ErrorKind::TimedOut
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -350,8 +333,7 @@ impl TcpStream {
|
||||
///
|
||||
/// Some platforms do not provide access to the current timeout.
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`read`]: ../../std/io/trait.Read.html#tymethod.read
|
||||
/// [`read`]: Read::read
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -376,8 +358,7 @@ impl TcpStream {
|
||||
///
|
||||
/// Some platforms do not provide access to the current timeout.
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`write`]: ../../std/io/trait.Write.html#tymethod.write
|
||||
/// [`write`]: Write::write
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -440,9 +421,7 @@ impl TcpStream {
|
||||
|
||||
/// Gets the value of the `TCP_NODELAY` option on this socket.
|
||||
///
|
||||
/// For more information about this option, see [`set_nodelay`][link].
|
||||
///
|
||||
/// [link]: #method.set_nodelay
|
||||
/// For more information about this option, see [`TcpStream::set_nodelay`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -480,9 +459,7 @@ impl TcpStream {
|
||||
|
||||
/// Gets the value of the `IP_TTL` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see [`set_ttl`][link].
|
||||
///
|
||||
/// [link]: #method.set_ttl
|
||||
/// For more information about this option, see [`TcpStream::set_ttl`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -559,8 +536,6 @@ impl TcpStream {
|
||||
/// };
|
||||
/// println!("bytes: {:?}", buf);
|
||||
/// ```
|
||||
///
|
||||
/// [`io::ErrorKind::WouldBlock`]: ../io/enum.ErrorKind.html#variant.WouldBlock
|
||||
#[stable(feature = "net2_mutators", since = "1.9.0")]
|
||||
pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
|
||||
self.0.set_nonblocking(nonblocking)
|
||||
@ -681,7 +656,7 @@ impl TcpListener {
|
||||
///
|
||||
/// Binding with a port number of 0 will request that the OS assigns a port
|
||||
/// to this listener. The port allocated can be queried via the
|
||||
/// [`local_addr`] method.
|
||||
/// [`TcpListener::local_addr`] method.
|
||||
///
|
||||
/// The address type can be any implementor of [`ToSocketAddrs`] trait. See
|
||||
/// its documentation for concrete examples.
|
||||
@ -691,9 +666,6 @@ impl TcpListener {
|
||||
/// none of the addresses succeed in creating a listener, the error returned
|
||||
/// from the last attempt (the last address) is returned.
|
||||
///
|
||||
/// [`local_addr`]: #method.local_addr
|
||||
/// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Creates a TCP listener bound to `127.0.0.1:80`:
|
||||
@ -743,8 +715,6 @@ impl TcpListener {
|
||||
/// object references. Both handles can be used to accept incoming
|
||||
/// connections and options set on one listener will affect the other.
|
||||
///
|
||||
/// [`TcpListener`]: ../../std/net/struct.TcpListener.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
@ -764,8 +734,6 @@ impl TcpListener {
|
||||
/// is established. When established, the corresponding [`TcpStream`] and the
|
||||
/// remote peer's address will be returned.
|
||||
///
|
||||
/// [`TcpStream`]: ../../std/net/struct.TcpStream.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
@ -790,11 +758,7 @@ impl TcpListener {
|
||||
///
|
||||
/// The returned iterator will never return [`None`] and will also not yield
|
||||
/// the peer's [`SocketAddr`] structure. Iterating over it is equivalent to
|
||||
/// calling [`accept`] in a loop.
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
|
||||
/// [`accept`]: #method.accept
|
||||
/// calling [`TcpListener::accept`] in a loop.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -837,9 +801,7 @@ impl TcpListener {
|
||||
|
||||
/// Gets the value of the `IP_TTL` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see [`set_ttl`][link].
|
||||
///
|
||||
/// [link]: #method.set_ttl
|
||||
/// For more information about this option, see [`TcpListener::set_ttl`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -936,8 +898,6 @@ impl TcpListener {
|
||||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// [`io::ErrorKind::WouldBlock`]: ../io/enum.ErrorKind.html#variant.WouldBlock
|
||||
#[stable(feature = "net2_mutators", since = "1.9.0")]
|
||||
pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
|
||||
self.0.set_nonblocking(nonblocking)
|
||||
|
||||
@ -19,15 +19,15 @@ use crate::time::Duration;
|
||||
/// an unordered, unreliable protocol; refer to [`TcpListener`] and [`TcpStream`] for TCP
|
||||
/// primitives.
|
||||
///
|
||||
/// [`bind`]: #method.bind
|
||||
/// [`connect`]: #method.connect
|
||||
/// [`bind`]: UdpSocket::bind
|
||||
/// [`connect`]: UdpSocket::connect
|
||||
/// [IETF RFC 768]: https://tools.ietf.org/html/rfc768
|
||||
/// [`recv`]: #method.recv
|
||||
/// [received from]: #method.recv_from
|
||||
/// [`send`]: #method.send
|
||||
/// [sent to]: #method.send_to
|
||||
/// [`TcpListener`]: ../../std/net/struct.TcpListener.html
|
||||
/// [`TcpStream`]: ../../std/net/struct.TcpStream.html
|
||||
/// [`recv`]: UdpSocket::recv
|
||||
/// [received from]: UdpSocket::recv_from
|
||||
/// [`send`]: UdpSocket::send
|
||||
/// [sent to]: UdpSocket::send_to
|
||||
/// [`TcpListener`]: crate::net::TcpListener
|
||||
/// [`TcpStream`]: crate::net::TcpStream
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -65,8 +65,6 @@ impl UdpSocket {
|
||||
/// of the addresses succeed in creating a socket, the error returned from
|
||||
/// the last attempt (the last address) is returned.
|
||||
///
|
||||
/// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Creates a UDP socket bound to `127.0.0.1:3400`:
|
||||
@ -160,8 +158,6 @@ impl UdpSocket {
|
||||
///
|
||||
/// See issue #34202 for more details.
|
||||
///
|
||||
/// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
@ -193,7 +189,7 @@ impl UdpSocket {
|
||||
///
|
||||
/// If the socket isn't connected, it will return a [`NotConnected`] error.
|
||||
///
|
||||
/// [`NotConnected`]: ../../std/io/enum.ErrorKind.html#variant.NotConnected
|
||||
/// [`NotConnected`]: io::ErrorKind::NotConnected
|
||||
///
|
||||
/// ```no_run
|
||||
/// use std::net::UdpSocket;
|
||||
@ -254,12 +250,9 @@ impl UdpSocket {
|
||||
/// a result of setting this option. For example Unix typically returns an
|
||||
/// error of the kind [`WouldBlock`], but Windows may return [`TimedOut`].
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`Err`]: ../../std/result/enum.Result.html#variant.Err
|
||||
/// [`read`]: ../../std/io/trait.Read.html#tymethod.read
|
||||
/// [`Duration`]: ../../std/time/struct.Duration.html
|
||||
/// [`WouldBlock`]: ../../std/io/enum.ErrorKind.html#variant.WouldBlock
|
||||
/// [`TimedOut`]: ../../std/io/enum.ErrorKind.html#variant.TimedOut
|
||||
/// [`read`]: io::Read::read
|
||||
/// [`WouldBlock`]: io::ErrorKind::WouldBlock
|
||||
/// [`TimedOut`]: io::ErrorKind::TimedOut
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -300,12 +293,9 @@ impl UdpSocket {
|
||||
/// as a result of setting this option. For example Unix typically returns
|
||||
/// an error of the kind [`WouldBlock`], but Windows may return [`TimedOut`].
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`Err`]: ../../std/result/enum.Result.html#variant.Err
|
||||
/// [`write`]: ../../std/io/trait.Write.html#tymethod.write
|
||||
/// [`Duration`]: ../../std/time/struct.Duration.html
|
||||
/// [`WouldBlock`]: ../../std/io/enum.ErrorKind.html#variant.WouldBlock
|
||||
/// [`TimedOut`]: ../../std/io/enum.ErrorKind.html#variant.TimedOut
|
||||
/// [`write`]: io::Write::write
|
||||
/// [`WouldBlock`]: io::ErrorKind::WouldBlock
|
||||
/// [`TimedOut`]: io::ErrorKind::TimedOut
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -338,8 +328,7 @@ impl UdpSocket {
|
||||
///
|
||||
/// If the timeout is [`None`], then [`read`] calls will block indefinitely.
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`read`]: ../../std/io/trait.Read.html#tymethod.read
|
||||
/// [`read`]: io::Read::read
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -359,8 +348,7 @@ impl UdpSocket {
|
||||
///
|
||||
/// If the timeout is [`None`], then [`write`] calls will block indefinitely.
|
||||
///
|
||||
/// [`None`]: ../../std/option/enum.Option.html#variant.None
|
||||
/// [`write`]: ../../std/io/trait.Write.html#tymethod.write
|
||||
/// [`write`]: io::Write::write
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -396,10 +384,7 @@ impl UdpSocket {
|
||||
|
||||
/// Gets the value of the `SO_BROADCAST` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see
|
||||
/// [`set_broadcast`][link].
|
||||
///
|
||||
/// [link]: #method.set_broadcast
|
||||
/// For more information about this option, see [`UdpSocket::set_broadcast`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -435,10 +420,7 @@ impl UdpSocket {
|
||||
|
||||
/// Gets the value of the `IP_MULTICAST_LOOP` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see
|
||||
/// [`set_multicast_loop_v4`][link].
|
||||
///
|
||||
/// [link]: #method.set_multicast_loop_v4
|
||||
/// For more information about this option, see [`UdpSocket::set_multicast_loop_v4`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -477,10 +459,7 @@ impl UdpSocket {
|
||||
|
||||
/// Gets the value of the `IP_MULTICAST_TTL` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see
|
||||
/// [`set_multicast_ttl_v4`][link].
|
||||
///
|
||||
/// [link]: #method.set_multicast_ttl_v4
|
||||
/// For more information about this option, see [`UdpSocket::set_multicast_ttl_v4`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -516,10 +495,7 @@ impl UdpSocket {
|
||||
|
||||
/// Gets the value of the `IPV6_MULTICAST_LOOP` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see
|
||||
/// [`set_multicast_loop_v6`][link].
|
||||
///
|
||||
/// [link]: #method.set_multicast_loop_v6
|
||||
/// For more information about this option, see [`UdpSocket::set_multicast_loop_v6`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -555,9 +531,7 @@ impl UdpSocket {
|
||||
|
||||
/// Gets the value of the `IP_TTL` option for this socket.
|
||||
///
|
||||
/// For more information about this option, see [`set_ttl`][link].
|
||||
///
|
||||
/// [link]: #method.set_ttl
|
||||
/// For more information about this option, see [`UdpSocket::set_ttl`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -597,10 +571,7 @@ impl UdpSocket {
|
||||
|
||||
/// Executes an operation of the `IP_DROP_MEMBERSHIP` type.
|
||||
///
|
||||
/// For more information about this option, see
|
||||
/// [`join_multicast_v4`][link].
|
||||
///
|
||||
/// [link]: #method.join_multicast_v4
|
||||
/// For more information about this option, see [`UdpSocket::join_multicast_v4`].
|
||||
#[stable(feature = "net2_mutators", since = "1.9.0")]
|
||||
pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
|
||||
self.0.leave_multicast_v4(multiaddr, interface)
|
||||
@ -608,10 +579,7 @@ impl UdpSocket {
|
||||
|
||||
/// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type.
|
||||
///
|
||||
/// For more information about this option, see
|
||||
/// [`join_multicast_v6`][link].
|
||||
///
|
||||
/// [link]: #method.join_multicast_v6
|
||||
/// For more information about this option, see [`UdpSocket::join_multicast_v6`].
|
||||
#[stable(feature = "net2_mutators", since = "1.9.0")]
|
||||
pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
|
||||
self.0.leave_multicast_v6(multiaddr, interface)
|
||||
@ -675,11 +643,9 @@ impl UdpSocket {
|
||||
|
||||
/// Sends data on the socket to the remote address to which it is connected.
|
||||
///
|
||||
/// The [`connect`] method will connect this socket to a remote address. This
|
||||
/// [`UdpSocket::connect`] will connect this socket to a remote address. This
|
||||
/// method will fail if the socket is not connected.
|
||||
///
|
||||
/// [`connect`]: #method.connect
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
@ -701,11 +667,9 @@ impl UdpSocket {
|
||||
/// hold the message bytes. If a message is too long to fit in the supplied buffer,
|
||||
/// excess bytes may be discarded.
|
||||
///
|
||||
/// The [`connect`] method will connect this socket to a remote address. This
|
||||
/// [`UdpSocket::connect`] will connect this socket to a remote address. This
|
||||
/// method will fail if the socket is not connected.
|
||||
///
|
||||
/// [`connect`]: #method.connect
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```no_run
|
||||
@ -738,11 +702,9 @@ impl UdpSocket {
|
||||
/// Do not use this function to implement busy waiting, instead use `libc::poll` to
|
||||
/// synchronize IO events on one or more sockets.
|
||||
///
|
||||
/// The [`connect`] method will connect this socket to a remote address. This
|
||||
/// [`UdpSocket::connect`] will connect this socket to a remote address. This
|
||||
/// method will fail if the socket is not connected.
|
||||
///
|
||||
/// [`connect`]: #method.connect
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// This method will fail if the socket is not connected. The `connect` method
|
||||
@ -779,8 +741,6 @@ impl UdpSocket {
|
||||
/// `FIONBIO`. On Windows calling this method corresponds to calling
|
||||
/// `ioctlsocket` `FIONBIO`.
|
||||
///
|
||||
/// [`io::ErrorKind::WouldBlock`]: ../io/enum.ErrorKind.html#variant.WouldBlock
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Creates a UDP socket bound to `127.0.0.1:7878` and read bytes in
|
||||
|
||||
Loading…
Reference in New Issue
Block a user