Skip to content

Commit 8252353

Browse files
committed
Document a possible way in which connect_timout may change in the future
1 parent 611c2ae commit 8252353

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/libstd/io/net/tcp.rs

+3
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ impl TcpStream {
9595
/// This is the same as the `connect` method, except that if the timeout
9696
/// specified (in milliseconds) elapses before a connection is made an error
9797
/// will be returned. The error's kind will be `TimedOut`.
98+
///
99+
/// Note that the `addr` argument may one day be split into a separate host
100+
/// and port, similar to the API seen in `connect`.
98101
#[experimental = "the timeout argument may eventually change types"]
99102
pub fn connect_timeout(addr: SocketAddr,
100103
timeout_ms: u64) -> IoResult<TcpStream> {

0 commit comments

Comments
 (0)