diff options
| author | Tom Lee <github@tomlee.co> | 2014-05-10 21:30:57 -0700 |
|---|---|---|
| committer | Tom Lee <github@tomlee.co> | 2014-05-12 21:41:48 -0700 |
| commit | 8252353916998ef43596ad62b27dd396afdd5de0 (patch) | |
| tree | 0ef463118a6ae90fc093cd125073cc749b62b9df /src/libstd/io | |
| parent | 611c2ae4f1411a36e3010a3a4f9145115a3a0e88 (diff) | |
Document a possible way in which connect_timout may change in the future
Diffstat (limited to 'src/libstd/io')
| -rw-r--r-- | src/libstd/io/net/tcp.rs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/libstd/io/net/tcp.rs b/src/libstd/io/net/tcp.rs index 42db3939e7d..0639611cc24 100644 --- a/src/libstd/io/net/tcp.rs +++ b/src/libstd/io/net/tcp.rs @@ -95,6 +95,9 @@ impl TcpStream { /// This is the same as the `connect` method, except that if the timeout /// specified (in milliseconds) elapses before a connection is made an error /// will be returned. The error's kind will be `TimedOut`. + /// + /// Note that the `addr` argument may one day be split into a separate host + /// and port, similar to the API seen in `connect`. #[experimental = "the timeout argument may eventually change types"] pub fn connect_timeout(addr: SocketAddr, timeout_ms: u64) -> IoResult<TcpStream> { |