squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

added missing links in std::net TCP docs

Browse source 
part of #29363
This commit is contained in:
lukaramu 2017-03-25 17:11:08 +01:00
parent 7dd4e2db78
commit 169facfc28
1 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/libstd/net/tcp.rs
View file

@ -83,11 +83,15 @@ impl TcpStream {
/// Opens a TCP connection to a remote host. /// Opens a TCP connection to a remote host.
/// ///
/// `addr` is an address of the remote host. Anything which implements /// `addr` is an address of the remote host. Anything which implements
/// `ToSocketAddrs` trait can be supplied for the address; see this trait /// [`ToSocketAddrs`] trait can be supplied for the address; see this trait
/// documentation for concrete examples. /// documentation for concrete examples.
/// In case `ToSocketAddrs::to_socket_addrs()` returns more than one entry, /// In case [`ToSocketAddrs::to_socket_addrs()`] returns more than one entry,
/// then the first valid and reachable address is used. /// then the first valid and reachable address is used.
/// ///
/// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
/// [`ToSocketAddrs::to_socket_addrs()`]:
/// ../../std/net/trait.ToSocketAddrs.html#tymethod.to_socket_addrs
///
/// # Examples /// # Examples
/// ///
/// ```no_run /// ```no_run
@ -494,11 +498,14 @@ impl TcpListener {
/// ///
/// Binding with a port number of 0 will request that the OS assigns a port /// 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 /// to this listener. The port allocated can be queried via the
/// `local_addr` method. /// [`local_addr`] method.
/// ///
/// The address type can be any implementor of `ToSocketAddrs` trait. See /// The address type can be any implementor of [`ToSocketAddrs`] trait. See
/// its documentation for concrete examples. /// its documentation for concrete examples.
/// ///
/// [`local_addr`]: #method.local_addr
/// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
///
/// # Examples /// # Examples
/// ///
/// ```no_run /// ```no_run
@ -529,10 +536,12 @@ impl TcpListener {
/// Creates a new independently owned handle to the underlying socket. /// Creates a new independently owned handle to the underlying socket.
/// ///
/// The returned `TcpListener` is a reference to the same socket that this /// The returned [`TcpListener`] is a reference to the same socket that this
/// object references. Both handles can be used to accept incoming /// object references. Both handles can be used to accept incoming
/// connections and options set on one listener will affect the other. /// connections and options set on one listener will affect the other.
/// ///
/// [`TcpListener`]: ../../std/net/struct.TcpListener.html
///
/// # Examples /// # Examples
/// ///
/// ```no_run /// ```no_run
@ -549,9 +558,11 @@ impl TcpListener {
/// Accept a new incoming connection from this listener. /// Accept a new incoming connection from this listener.
/// ///
/// This function will block the calling thread until a new TCP connection /// This function will block the calling thread until a new TCP connection
/// is established. When established, the corresponding `TcpStream` and the /// is established. When established, the corresponding [`TcpStream`] and the
/// remote peer's address will be returned. /// remote peer's address will be returned.
/// ///
/// [`TcpStream`]: ../../std/net/struct.TcpStream.html
///
/// # Examples /// # Examples
/// ///
/// ```no_run /// ```no_run