From 6aa01825204e8c3c29d104935de78df74a8e51d3 Mon Sep 17 00:00:00 2001 From: Tobias Bucher Date: Wed, 29 Jun 2016 11:44:33 +0200 Subject: [PATCH] Update documentation to reflect ignoring of unknown addresses --- src/libstd/net/addr.rs | 3 +++ src/libstd/net/mod.rs | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/libstd/net/addr.rs b/src/libstd/net/addr.rs index 44a7823f82a..b93ca8277e6 100644 --- a/src/libstd/net/addr.rs +++ b/src/libstd/net/addr.rs @@ -344,6 +344,9 @@ fn hash(&self, s: &mut H) { /// some other type (e.g. a string) just for it to be converted back to /// `SocketAddr` in constructor methods is pointless. /// +/// Addresses returned by the operating system that are not IP addresses are +/// silently ignored. +/// /// Some examples: /// /// ```no_run diff --git a/src/libstd/net/mod.rs b/src/libstd/net/mod.rs index 95df7f7eaeb..ac13b23ebee 100644 --- a/src/libstd/net/mod.rs +++ b/src/libstd/net/mod.rs @@ -107,6 +107,9 @@ fn next(&mut self) -> Option { self.0.next() } /// This method may perform a DNS query to resolve `host` and may also inspect /// system configuration to resolve the specified hostname. /// +/// The returned iterator will skip over any unknown addresses returned by the +/// operating system. +/// /// # Examples /// /// ```no_run @@ -116,7 +119,7 @@ fn next(&mut self) -> Option { self.0.next() } /// /// # fn foo() -> std::io::Result<()> { /// for host in try!(net::lookup_host("rust-lang.org")) { -/// println!("found address: {}", try!(host)); +/// println!("found address: {}", host); /// } /// # Ok(()) /// # }