diff options
| author | benaryorg <binary@benary.org> | 2016-04-23 17:50:16 +0200 |
|---|---|---|
| committer | benaryorg <binary@benary.org> | 2016-04-23 17:51:22 +0200 |
| commit | 68a18c4dbc8589a6cffcf16626e3d57633b32463 (patch) | |
| tree | 959b2073f63ca6227f4f5ca4393bf8d95065b43b /src/libstd/net | |
| parent | f01bb5ed24c90f80bf30d0967679d21111d5f298 (diff) | |
| download | rust-68a18c4dbc8589a6cffcf16626e3d57633b32463.tar.gz rust-68a18c4dbc8589a6cffcf16626e3d57633b32463.zip | |
clarify documentation of TcpStream::connect() for multiple valid addresses
Signed-off-by: benaryorg <binary@benary.org>
Diffstat (limited to 'src/libstd/net')
| -rw-r--r-- | src/libstd/net/tcp.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/libstd/net/tcp.rs b/src/libstd/net/tcp.rs index 38da74b8903..9265705fac0 100644 --- a/src/libstd/net/tcp.rs +++ b/src/libstd/net/tcp.rs @@ -86,6 +86,8 @@ impl TcpStream { /// `addr` is an address of the remote host. Anything which implements /// `ToSocketAddrs` trait can be supplied for the address; see this trait /// documentation for concrete examples. + /// In case `ToSocketAddrs::to_socket_addrs()` returns more than one entry, + /// then the first valid and reachable address is used. #[stable(feature = "rust1", since = "1.0.0")] pub fn connect<A: ToSocketAddrs>(addr: A) -> io::Result<TcpStream> { super::each_addr(addr, net_imp::TcpStream::connect).map(TcpStream) |