]> git.lizzy.rs Git - rust.git/blob - src/libstd/net/addr.rs
Auto merge of #37960 - samestep:five, r=frewsxcv
[rust.git] / src / libstd / net / addr.rs
1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 use fmt;
12 use hash;
13 use io;
14 use mem;
15 use net::{lookup_host, ntoh, hton, IpAddr, Ipv4Addr, Ipv6Addr};
16 use option;
17 use sys::net::netc as c;
18 use sys_common::{FromInner, AsInner, IntoInner};
19 use vec;
20 use iter;
21 use slice;
22
23 /// Representation of a socket address for networking applications.
24 ///
25 /// A socket address can either represent the IPv4 or IPv6 protocol and is
26 /// paired with at least a port number as well. Each protocol may have more
27 /// specific information about the address available to it as well.
28 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
29 #[stable(feature = "rust1", since = "1.0.0")]
30 pub enum SocketAddr {
31     /// An IPv4 socket address which is a (ip, port) combination.
32     #[stable(feature = "rust1", since = "1.0.0")]
33     V4(#[stable(feature = "rust1", since = "1.0.0")] SocketAddrV4),
34     /// An IPv6 socket address.
35     #[stable(feature = "rust1", since = "1.0.0")]
36     V6(#[stable(feature = "rust1", since = "1.0.0")] SocketAddrV6),
37 }
38
39 /// An IPv4 socket address which is a (ip, port) combination.
40 #[derive(Copy)]
41 #[stable(feature = "rust1", since = "1.0.0")]
42 pub struct SocketAddrV4 { inner: c::sockaddr_in }
43
44 /// An IPv6 socket address.
45 #[derive(Copy)]
46 #[stable(feature = "rust1", since = "1.0.0")]
47 pub struct SocketAddrV6 { inner: c::sockaddr_in6 }
48
49 impl SocketAddr {
50     /// Creates a new socket address from the (ip, port) pair.
51     ///
52     /// # Examples
53     ///
54     /// ```
55     /// use std::net::{IpAddr, Ipv4Addr, SocketAddr};
56     ///
57     /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
58     /// assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
59     /// assert_eq!(socket.port(), 8080);
60     /// ```
61     #[stable(feature = "ip_addr", since = "1.7.0")]
62     pub fn new(ip: IpAddr, port: u16) -> SocketAddr {
63         match ip {
64             IpAddr::V4(a) => SocketAddr::V4(SocketAddrV4::new(a, port)),
65             IpAddr::V6(a) => SocketAddr::V6(SocketAddrV6::new(a, port, 0, 0)),
66         }
67     }
68
69     /// Returns the IP address associated with this socket address.
70     ///
71     /// # Examples
72     ///
73     /// ```
74     /// use std::net::{IpAddr, Ipv4Addr, SocketAddr};
75     ///
76     /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
77     /// assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
78     /// ```
79     #[stable(feature = "ip_addr", since = "1.7.0")]
80     pub fn ip(&self) -> IpAddr {
81         match *self {
82             SocketAddr::V4(ref a) => IpAddr::V4(*a.ip()),
83             SocketAddr::V6(ref a) => IpAddr::V6(*a.ip()),
84         }
85     }
86
87     /// Change the IP address associated with this socket address.
88     ///
89     /// # Examples
90     ///
91     /// ```
92     /// use std::net::{IpAddr, Ipv4Addr, SocketAddr};
93     ///
94     /// let mut socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
95     /// socket.set_ip(IpAddr::V4(Ipv4Addr::new(10, 10, 0, 1)));
96     /// assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(10, 10, 0, 1)));
97     /// ```
98     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
99     pub fn set_ip(&mut self, new_ip: IpAddr) {
100         // `match (*self, new_ip)` would have us mutate a copy of self only to throw it away.
101         match (self, new_ip) {
102             (&mut SocketAddr::V4(ref mut a), IpAddr::V4(new_ip)) => a.set_ip(new_ip),
103             (&mut SocketAddr::V6(ref mut a), IpAddr::V6(new_ip)) => a.set_ip(new_ip),
104             (self_, new_ip) => *self_ = Self::new(new_ip, self_.port()),
105         }
106     }
107
108     /// Returns the port number associated with this socket address.
109     ///
110     /// # Examples
111     ///
112     /// ```
113     /// use std::net::{IpAddr, Ipv4Addr, SocketAddr};
114     ///
115     /// let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
116     /// assert_eq!(socket.port(), 8080);
117     /// ```
118     #[stable(feature = "rust1", since = "1.0.0")]
119     pub fn port(&self) -> u16 {
120         match *self {
121             SocketAddr::V4(ref a) => a.port(),
122             SocketAddr::V6(ref a) => a.port(),
123         }
124     }
125
126     /// Change the port number associated with this socket address.
127     ///
128     /// # Examples
129     ///
130     /// ```
131     /// use std::net::{IpAddr, Ipv4Addr, SocketAddr};
132     ///
133     /// let mut socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
134     /// socket.set_port(1025);
135     /// assert_eq!(socket.port(), 1025);
136     /// ```
137     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
138     pub fn set_port(&mut self, new_port: u16) {
139         match *self {
140             SocketAddr::V4(ref mut a) => a.set_port(new_port),
141             SocketAddr::V6(ref mut a) => a.set_port(new_port),
142         }
143     }
144
145     /// Returns true if the IP in this `SocketAddr` is a valid IPv4 address,
146     /// false if it's a valid IPv6 address.
147     ///
148     /// # Examples
149     ///
150     /// ```
151     /// #![feature(sockaddr_checker)]
152     ///
153     /// use std::net::{IpAddr, Ipv4Addr, SocketAddr};
154     ///
155     /// fn main() {
156     ///     let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
157     ///     assert_eq!(socket.is_ipv4(), true);
158     ///     assert_eq!(socket.is_ipv6(), false);
159     /// }
160     /// ```
161     #[unstable(feature = "sockaddr_checker", issue = "36949")]
162     pub fn is_ipv4(&self) -> bool {
163         match *self {
164             SocketAddr::V4(_) => true,
165             SocketAddr::V6(_) => false,
166         }
167     }
168
169     /// Returns true if the IP in this `SocketAddr` is a valid IPv6 address,
170     /// false if it's a valid IPv4 address.
171     ///
172     /// # Examples
173     ///
174     /// ```
175     /// #![feature(sockaddr_checker)]
176     ///
177     /// use std::net::{IpAddr, Ipv6Addr, SocketAddr};
178     ///
179     /// fn main() {
180     ///     let socket = SocketAddr::new(
181     ///                      IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 0, 1)), 8080);
182     ///     assert_eq!(socket.is_ipv4(), false);
183     ///     assert_eq!(socket.is_ipv6(), true);
184     /// }
185     /// ```
186     #[unstable(feature = "sockaddr_checker", issue = "36949")]
187     pub fn is_ipv6(&self) -> bool {
188         match *self {
189             SocketAddr::V4(_) => false,
190             SocketAddr::V6(_) => true,
191         }
192     }
193 }
194
195 impl SocketAddrV4 {
196     /// Creates a new socket address from the (ip, port) pair.
197     ///
198     /// # Examples
199     ///
200     /// ```
201     /// use std::net::{SocketAddrV4, Ipv4Addr};
202     ///
203     /// let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
204     /// ```
205     #[stable(feature = "rust1", since = "1.0.0")]
206     pub fn new(ip: Ipv4Addr, port: u16) -> SocketAddrV4 {
207         SocketAddrV4 {
208             inner: c::sockaddr_in {
209                 sin_family: c::AF_INET as c::sa_family_t,
210                 sin_port: hton(port),
211                 sin_addr: *ip.as_inner(),
212                 .. unsafe { mem::zeroed() }
213             },
214         }
215     }
216
217     /// Returns the IP address associated with this socket address.
218     ///
219     /// # Examples
220     ///
221     /// ```
222     /// use std::net::{SocketAddrV4, Ipv4Addr};
223     ///
224     /// let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
225     /// assert_eq!(socket.ip(), &Ipv4Addr::new(127, 0, 0, 1));
226     /// ```
227     #[stable(feature = "rust1", since = "1.0.0")]
228     pub fn ip(&self) -> &Ipv4Addr {
229         unsafe {
230             &*(&self.inner.sin_addr as *const c::in_addr as *const Ipv4Addr)
231         }
232     }
233
234     /// Change the IP address associated with this socket address.
235     ///
236     /// # Examples
237     ///
238     /// ```
239     /// use std::net::{SocketAddrV4, Ipv4Addr};
240     ///
241     /// let mut socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
242     /// socket.set_ip(Ipv4Addr::new(192, 168, 0, 1));
243     /// assert_eq!(socket.ip(), &Ipv4Addr::new(192, 168, 0, 1));
244     /// ```
245     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
246     pub fn set_ip(&mut self, new_ip: Ipv4Addr) {
247         self.inner.sin_addr = *new_ip.as_inner()
248     }
249
250     /// Returns the port number associated with this socket address.
251     ///
252     /// # Examples
253     ///
254     /// ```
255     /// use std::net::{SocketAddrV4, Ipv4Addr};
256     ///
257     /// let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
258     /// assert_eq!(socket.port(), 8080);
259     /// ```
260     #[stable(feature = "rust1", since = "1.0.0")]
261     pub fn port(&self) -> u16 {
262         ntoh(self.inner.sin_port)
263     }
264
265     /// Change the port number associated with this socket address.
266     ///
267     /// # Examples
268     ///
269     /// ```
270     /// use std::net::{SocketAddrV4, Ipv4Addr};
271     ///
272     /// let mut socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
273     /// socket.set_port(4242);
274     /// assert_eq!(socket.port(), 4242);
275     /// ```
276     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
277     pub fn set_port(&mut self, new_port: u16) {
278         self.inner.sin_port = hton(new_port);
279     }
280 }
281
282 impl SocketAddrV6 {
283     /// Creates a new socket address from the ip/port/flowinfo/scope_id
284     /// components.
285     #[stable(feature = "rust1", since = "1.0.0")]
286     pub fn new(ip: Ipv6Addr, port: u16, flowinfo: u32, scope_id: u32)
287                -> SocketAddrV6 {
288         SocketAddrV6 {
289             inner: c::sockaddr_in6 {
290                 sin6_family: c::AF_INET6 as c::sa_family_t,
291                 sin6_port: hton(port),
292                 sin6_addr: *ip.as_inner(),
293                 sin6_flowinfo: flowinfo,
294                 sin6_scope_id: scope_id,
295                 .. unsafe { mem::zeroed() }
296             },
297         }
298     }
299
300     /// Returns the IP address associated with this socket address.
301     #[stable(feature = "rust1", since = "1.0.0")]
302     pub fn ip(&self) -> &Ipv6Addr {
303         unsafe {
304             &*(&self.inner.sin6_addr as *const c::in6_addr as *const Ipv6Addr)
305         }
306     }
307
308     /// Change the IP address associated with this socket address.
309     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
310     pub fn set_ip(&mut self, new_ip: Ipv6Addr) {
311         self.inner.sin6_addr = *new_ip.as_inner()
312     }
313
314     /// Returns the port number associated with this socket address.
315     #[stable(feature = "rust1", since = "1.0.0")]
316     pub fn port(&self) -> u16 {
317         ntoh(self.inner.sin6_port)
318     }
319
320     /// Change the port number associated with this socket address.
321     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
322     pub fn set_port(&mut self, new_port: u16) {
323         self.inner.sin6_port = hton(new_port);
324     }
325
326     /// Returns the flow information associated with this address,
327     /// corresponding to the `sin6_flowinfo` field in C.
328     #[stable(feature = "rust1", since = "1.0.0")]
329     pub fn flowinfo(&self) -> u32 {
330         self.inner.sin6_flowinfo
331     }
332
333     /// Change the flow information associated with this socket address.
334     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
335     pub fn set_flowinfo(&mut self, new_flowinfo: u32) {
336         self.inner.sin6_flowinfo = new_flowinfo;
337     }
338
339     /// Returns the scope ID associated with this address,
340     /// corresponding to the `sin6_scope_id` field in C.
341     #[stable(feature = "rust1", since = "1.0.0")]
342     pub fn scope_id(&self) -> u32 {
343         self.inner.sin6_scope_id
344     }
345
346     /// Change the scope ID associated with this socket address.
347     #[stable(feature = "sockaddr_setters", since = "1.9.0")]
348     pub fn set_scope_id(&mut self, new_scope_id: u32) {
349         self.inner.sin6_scope_id = new_scope_id;
350     }
351 }
352
353 impl FromInner<c::sockaddr_in> for SocketAddrV4 {
354     fn from_inner(addr: c::sockaddr_in) -> SocketAddrV4 {
355         SocketAddrV4 { inner: addr }
356     }
357 }
358
359 impl FromInner<c::sockaddr_in6> for SocketAddrV6 {
360     fn from_inner(addr: c::sockaddr_in6) -> SocketAddrV6 {
361         SocketAddrV6 { inner: addr }
362     }
363 }
364
365 impl<'a> IntoInner<(*const c::sockaddr, c::socklen_t)> for &'a SocketAddr {
366     fn into_inner(self) -> (*const c::sockaddr, c::socklen_t) {
367         match *self {
368             SocketAddr::V4(ref a) => {
369                 (a as *const _ as *const _, mem::size_of_val(a) as c::socklen_t)
370             }
371             SocketAddr::V6(ref a) => {
372                 (a as *const _ as *const _, mem::size_of_val(a) as c::socklen_t)
373             }
374         }
375     }
376 }
377
378 #[stable(feature = "rust1", since = "1.0.0")]
379 impl fmt::Display for SocketAddr {
380     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
381         match *self {
382             SocketAddr::V4(ref a) => a.fmt(f),
383             SocketAddr::V6(ref a) => a.fmt(f),
384         }
385     }
386 }
387
388 #[stable(feature = "rust1", since = "1.0.0")]
389 impl fmt::Display for SocketAddrV4 {
390     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
391         write!(f, "{}:{}", self.ip(), self.port())
392     }
393 }
394
395 #[stable(feature = "rust1", since = "1.0.0")]
396 impl fmt::Debug for SocketAddrV4 {
397     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
398         fmt::Display::fmt(self, fmt)
399     }
400 }
401
402 #[stable(feature = "rust1", since = "1.0.0")]
403 impl fmt::Display for SocketAddrV6 {
404     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
405         write!(f, "[{}]:{}", self.ip(), self.port())
406     }
407 }
408
409 #[stable(feature = "rust1", since = "1.0.0")]
410 impl fmt::Debug for SocketAddrV6 {
411     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
412         fmt::Display::fmt(self, fmt)
413     }
414 }
415
416 #[stable(feature = "rust1", since = "1.0.0")]
417 impl Clone for SocketAddrV4 {
418     fn clone(&self) -> SocketAddrV4 { *self }
419 }
420 #[stable(feature = "rust1", since = "1.0.0")]
421 impl Clone for SocketAddrV6 {
422     fn clone(&self) -> SocketAddrV6 { *self }
423 }
424
425 #[stable(feature = "rust1", since = "1.0.0")]
426 impl PartialEq for SocketAddrV4 {
427     fn eq(&self, other: &SocketAddrV4) -> bool {
428         self.inner.sin_port == other.inner.sin_port &&
429             self.inner.sin_addr.s_addr == other.inner.sin_addr.s_addr
430     }
431 }
432 #[stable(feature = "rust1", since = "1.0.0")]
433 impl PartialEq for SocketAddrV6 {
434     fn eq(&self, other: &SocketAddrV6) -> bool {
435         self.inner.sin6_port == other.inner.sin6_port &&
436             self.inner.sin6_addr.s6_addr == other.inner.sin6_addr.s6_addr &&
437             self.inner.sin6_flowinfo == other.inner.sin6_flowinfo &&
438             self.inner.sin6_scope_id == other.inner.sin6_scope_id
439     }
440 }
441 #[stable(feature = "rust1", since = "1.0.0")]
442 impl Eq for SocketAddrV4 {}
443 #[stable(feature = "rust1", since = "1.0.0")]
444 impl Eq for SocketAddrV6 {}
445
446 #[stable(feature = "rust1", since = "1.0.0")]
447 impl hash::Hash for SocketAddrV4 {
448     fn hash<H: hash::Hasher>(&self, s: &mut H) {
449         (self.inner.sin_port, self.inner.sin_addr.s_addr).hash(s)
450     }
451 }
452 #[stable(feature = "rust1", since = "1.0.0")]
453 impl hash::Hash for SocketAddrV6 {
454     fn hash<H: hash::Hasher>(&self, s: &mut H) {
455         (self.inner.sin6_port, &self.inner.sin6_addr.s6_addr,
456          self.inner.sin6_flowinfo, self.inner.sin6_scope_id).hash(s)
457     }
458 }
459
460 /// A trait for objects which can be converted or resolved to one or more
461 /// `SocketAddr` values.
462 ///
463 /// This trait is used for generic address resolution when constructing network
464 /// objects.  By default it is implemented for the following types:
465 ///
466 ///  * `SocketAddr`, `SocketAddrV4`, `SocketAddrV6` - `to_socket_addrs` is
467 ///    identity function.
468 ///
469 ///  * `(IpvNAddr, u16)` - `to_socket_addrs` constructs `SocketAddr` trivially.
470 ///
471 ///  * `(&str, u16)` - the string should be either a string representation of an
472 ///    IP address expected by `FromStr` implementation for `IpvNAddr` or a host
473 ///    name.
474 ///
475 ///  * `&str` - the string should be either a string representation of a
476 ///    `SocketAddr` as expected by its `FromStr` implementation or a string like
477 ///    `<host_name>:<port>` pair where `<port>` is a `u16` value.
478 ///
479 /// This trait allows constructing network objects like `TcpStream` or
480 /// `UdpSocket` easily with values of various types for the bind/connection
481 /// address. It is needed because sometimes one type is more appropriate than
482 /// the other: for simple uses a string like `"localhost:12345"` is much nicer
483 /// than manual construction of the corresponding `SocketAddr`, but sometimes
484 /// `SocketAddr` value is *the* main source of the address, and converting it to
485 /// some other type (e.g. a string) just for it to be converted back to
486 /// `SocketAddr` in constructor methods is pointless.
487 ///
488 /// Addresses returned by the operating system that are not IP addresses are
489 /// silently ignored.
490 ///
491 /// Some examples:
492 ///
493 /// ```no_run
494 /// use std::net::{SocketAddrV4, TcpStream, UdpSocket, TcpListener, Ipv4Addr};
495 ///
496 /// fn main() {
497 ///     let ip = Ipv4Addr::new(127, 0, 0, 1);
498 ///     let port = 12345;
499 ///
500 ///     // The following lines are equivalent modulo possible "localhost" name
501 ///     // resolution differences
502 ///     let tcp_s = TcpStream::connect(SocketAddrV4::new(ip, port));
503 ///     let tcp_s = TcpStream::connect((ip, port));
504 ///     let tcp_s = TcpStream::connect(("127.0.0.1", port));
505 ///     let tcp_s = TcpStream::connect(("localhost", port));
506 ///     let tcp_s = TcpStream::connect("127.0.0.1:12345");
507 ///     let tcp_s = TcpStream::connect("localhost:12345");
508 ///
509 ///     // TcpListener::bind(), UdpSocket::bind() and UdpSocket::send_to()
510 ///     // behave similarly
511 ///     let tcp_l = TcpListener::bind("localhost:12345");
512 ///
513 ///     let mut udp_s = UdpSocket::bind(("127.0.0.1", port)).unwrap();
514 ///     udp_s.send_to(&[7], (ip, 23451)).unwrap();
515 /// }
516 /// ```
517 #[stable(feature = "rust1", since = "1.0.0")]
518 pub trait ToSocketAddrs {
519     /// Returned iterator over socket addresses which this type may correspond
520     /// to.
521     #[stable(feature = "rust1", since = "1.0.0")]
522     type Iter: Iterator<Item=SocketAddr>;
523
524     /// Converts this object to an iterator of resolved `SocketAddr`s.
525     ///
526     /// The returned iterator may not actually yield any values depending on the
527     /// outcome of any resolution performed.
528     ///
529     /// Note that this function may block the current thread while resolution is
530     /// performed.
531     ///
532     /// # Errors
533     ///
534     /// Any errors encountered during resolution will be returned as an `Err`.
535     #[stable(feature = "rust1", since = "1.0.0")]
536     fn to_socket_addrs(&self) -> io::Result<Self::Iter>;
537 }
538
539 #[stable(feature = "rust1", since = "1.0.0")]
540 impl ToSocketAddrs for SocketAddr {
541     type Iter = option::IntoIter<SocketAddr>;
542     fn to_socket_addrs(&self) -> io::Result<option::IntoIter<SocketAddr>> {
543         Ok(Some(*self).into_iter())
544     }
545 }
546
547 #[stable(feature = "rust1", since = "1.0.0")]
548 impl ToSocketAddrs for SocketAddrV4 {
549     type Iter = option::IntoIter<SocketAddr>;
550     fn to_socket_addrs(&self) -> io::Result<option::IntoIter<SocketAddr>> {
551         SocketAddr::V4(*self).to_socket_addrs()
552     }
553 }
554
555 #[stable(feature = "rust1", since = "1.0.0")]
556 impl ToSocketAddrs for SocketAddrV6 {
557     type Iter = option::IntoIter<SocketAddr>;
558     fn to_socket_addrs(&self) -> io::Result<option::IntoIter<SocketAddr>> {
559         SocketAddr::V6(*self).to_socket_addrs()
560     }
561 }
562
563 #[stable(feature = "rust1", since = "1.0.0")]
564 impl ToSocketAddrs for (IpAddr, u16) {
565     type Iter = option::IntoIter<SocketAddr>;
566     fn to_socket_addrs(&self) -> io::Result<option::IntoIter<SocketAddr>> {
567         let (ip, port) = *self;
568         match ip {
569             IpAddr::V4(ref a) => (*a, port).to_socket_addrs(),
570             IpAddr::V6(ref a) => (*a, port).to_socket_addrs(),
571         }
572     }
573 }
574
575 #[stable(feature = "rust1", since = "1.0.0")]
576 impl ToSocketAddrs for (Ipv4Addr, u16) {
577     type Iter = option::IntoIter<SocketAddr>;
578     fn to_socket_addrs(&self) -> io::Result<option::IntoIter<SocketAddr>> {
579         let (ip, port) = *self;
580         SocketAddrV4::new(ip, port).to_socket_addrs()
581     }
582 }
583
584 #[stable(feature = "rust1", since = "1.0.0")]
585 impl ToSocketAddrs for (Ipv6Addr, u16) {
586     type Iter = option::IntoIter<SocketAddr>;
587     fn to_socket_addrs(&self) -> io::Result<option::IntoIter<SocketAddr>> {
588         let (ip, port) = *self;
589         SocketAddrV6::new(ip, port, 0, 0).to_socket_addrs()
590     }
591 }
592
593 fn resolve_socket_addr(s: &str, p: u16) -> io::Result<vec::IntoIter<SocketAddr>> {
594     let ips = lookup_host(s)?;
595     let v: Vec<_> = ips.map(|mut a| { a.set_port(p); a }).collect();
596     Ok(v.into_iter())
597 }
598
599 #[stable(feature = "rust1", since = "1.0.0")]
600 impl<'a> ToSocketAddrs for (&'a str, u16) {
601     type Iter = vec::IntoIter<SocketAddr>;
602     fn to_socket_addrs(&self) -> io::Result<vec::IntoIter<SocketAddr>> {
603         let (host, port) = *self;
604
605         // try to parse the host as a regular IP address first
606         if let Ok(addr) = host.parse::<Ipv4Addr>() {
607             let addr = SocketAddrV4::new(addr, port);
608             return Ok(vec![SocketAddr::V4(addr)].into_iter())
609         }
610         if let Ok(addr) = host.parse::<Ipv6Addr>() {
611             let addr = SocketAddrV6::new(addr, port, 0, 0);
612             return Ok(vec![SocketAddr::V6(addr)].into_iter())
613         }
614
615         resolve_socket_addr(host, port)
616     }
617 }
618
619 // accepts strings like 'localhost:12345'
620 #[stable(feature = "rust1", since = "1.0.0")]
621 impl ToSocketAddrs for str {
622     type Iter = vec::IntoIter<SocketAddr>;
623     fn to_socket_addrs(&self) -> io::Result<vec::IntoIter<SocketAddr>> {
624         // try to parse as a regular SocketAddr first
625         if let Some(addr) = self.parse().ok() {
626             return Ok(vec![addr].into_iter());
627         }
628
629         macro_rules! try_opt {
630             ($e:expr, $msg:expr) => (
631                 match $e {
632                     Some(r) => r,
633                     None => return Err(io::Error::new(io::ErrorKind::InvalidInput,
634                                                       $msg)),
635                 }
636             )
637         }
638
639         // split the string by ':' and convert the second part to u16
640         let mut parts_iter = self.rsplitn(2, ':');
641         let port_str = try_opt!(parts_iter.next(), "invalid socket address");
642         let host = try_opt!(parts_iter.next(), "invalid socket address");
643         let port: u16 = try_opt!(port_str.parse().ok(), "invalid port value");
644         resolve_socket_addr(host, port)
645     }
646 }
647
648 #[stable(feature = "slice_to_socket_addrs", since = "1.8.0")]
649 impl<'a> ToSocketAddrs for &'a [SocketAddr] {
650     type Iter = iter::Cloned<slice::Iter<'a, SocketAddr>>;
651
652     fn to_socket_addrs(&self) -> io::Result<Self::Iter> {
653         Ok(self.iter().cloned())
654     }
655 }
656
657 #[stable(feature = "rust1", since = "1.0.0")]
658 impl<'a, T: ToSocketAddrs + ?Sized> ToSocketAddrs for &'a T {
659     type Iter = T::Iter;
660     fn to_socket_addrs(&self) -> io::Result<T::Iter> {
661         (**self).to_socket_addrs()
662     }
663 }
664
665 #[cfg(all(test, not(target_os = "emscripten")))]
666 mod tests {
667     use net::*;
668     use net::test::{tsa, sa6, sa4};
669
670     #[test]
671     fn to_socket_addr_ipaddr_u16() {
672         let a = Ipv4Addr::new(77, 88, 21, 11);
673         let p = 12345;
674         let e = SocketAddr::V4(SocketAddrV4::new(a, p));
675         assert_eq!(Ok(vec![e]), tsa((a, p)));
676     }
677
678     #[test]
679     fn to_socket_addr_str_u16() {
680         let a = sa4(Ipv4Addr::new(77, 88, 21, 11), 24352);
681         assert_eq!(Ok(vec![a]), tsa(("77.88.21.11", 24352)));
682
683         let a = sa6(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53);
684         assert_eq!(Ok(vec![a]), tsa(("2a02:6b8:0:1::1", 53)));
685
686         let a = sa4(Ipv4Addr::new(127, 0, 0, 1), 23924);
687         assert!(tsa(("localhost", 23924)).unwrap().contains(&a));
688     }
689
690     #[test]
691     fn to_socket_addr_str() {
692         let a = sa4(Ipv4Addr::new(77, 88, 21, 11), 24352);
693         assert_eq!(Ok(vec![a]), tsa("77.88.21.11:24352"));
694
695         let a = sa6(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 53);
696         assert_eq!(Ok(vec![a]), tsa("[2a02:6b8:0:1::1]:53"));
697
698         let a = sa4(Ipv4Addr::new(127, 0, 0, 1), 23924);
699         assert!(tsa("localhost:23924").unwrap().contains(&a));
700     }
701
702     // FIXME: figure out why this fails on openbsd and bitrig and fix it
703     #[test]
704     #[cfg(not(any(windows, target_os = "openbsd", target_os = "bitrig")))]
705     fn to_socket_addr_str_bad() {
706         assert!(tsa("1200::AB00:1234::2552:7777:1313:34300").is_err());
707     }
708
709     #[test]
710     fn set_ip() {
711         fn ip4(low: u8) -> Ipv4Addr { Ipv4Addr::new(77, 88, 21, low) }
712         fn ip6(low: u16) -> Ipv6Addr { Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, low) }
713
714         let mut v4 = SocketAddrV4::new(ip4(11), 80);
715         assert_eq!(v4.ip(), &ip4(11));
716         v4.set_ip(ip4(12));
717         assert_eq!(v4.ip(), &ip4(12));
718
719         let mut addr = SocketAddr::V4(v4);
720         assert_eq!(addr.ip(), IpAddr::V4(ip4(12)));
721         addr.set_ip(IpAddr::V4(ip4(13)));
722         assert_eq!(addr.ip(), IpAddr::V4(ip4(13)));
723         addr.set_ip(IpAddr::V6(ip6(14)));
724         assert_eq!(addr.ip(), IpAddr::V6(ip6(14)));
725
726         let mut v6 = SocketAddrV6::new(ip6(1), 80, 0, 0);
727         assert_eq!(v6.ip(), &ip6(1));
728         v6.set_ip(ip6(2));
729         assert_eq!(v6.ip(), &ip6(2));
730
731         let mut addr = SocketAddr::V6(v6);
732         assert_eq!(addr.ip(), IpAddr::V6(ip6(2)));
733         addr.set_ip(IpAddr::V6(ip6(3)));
734         assert_eq!(addr.ip(), IpAddr::V6(ip6(3)));
735         addr.set_ip(IpAddr::V4(ip4(4)));
736         assert_eq!(addr.ip(), IpAddr::V4(ip4(4)));
737     }
738
739     #[test]
740     fn set_port() {
741         let mut v4 = SocketAddrV4::new(Ipv4Addr::new(77, 88, 21, 11), 80);
742         assert_eq!(v4.port(), 80);
743         v4.set_port(443);
744         assert_eq!(v4.port(), 443);
745
746         let mut addr = SocketAddr::V4(v4);
747         assert_eq!(addr.port(), 443);
748         addr.set_port(8080);
749         assert_eq!(addr.port(), 8080);
750
751         let mut v6 = SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 80, 0, 0);
752         assert_eq!(v6.port(), 80);
753         v6.set_port(443);
754         assert_eq!(v6.port(), 443);
755
756         let mut addr = SocketAddr::V6(v6);
757         assert_eq!(addr.port(), 443);
758         addr.set_port(8080);
759         assert_eq!(addr.port(), 8080);
760     }
761
762     #[test]
763     fn set_flowinfo() {
764         let mut v6 = SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 80, 10, 0);
765         assert_eq!(v6.flowinfo(), 10);
766         v6.set_flowinfo(20);
767         assert_eq!(v6.flowinfo(), 20);
768     }
769
770     #[test]
771     fn set_scope_id() {
772         let mut v6 = SocketAddrV6::new(Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 80, 0, 10);
773         assert_eq!(v6.scope_id(), 10);
774         v6.set_scope_id(20);
775         assert_eq!(v6.scope_id(), 20);
776     }
777
778     #[test]
779     fn is_v4() {
780         let v4 = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(77, 88, 21, 11), 80));
781         assert!(v4.is_ipv4());
782         assert!(!v4.is_ipv6());
783     }
784
785     #[test]
786     fn is_v6() {
787         let v6 = SocketAddr::V6(SocketAddrV6::new(
788                 Ipv6Addr::new(0x2a02, 0x6b8, 0, 1, 0, 0, 0, 1), 80, 10, 0));
789         assert!(!v6.is_ipv4());
790         assert!(v6.is_ipv6());
791     }
792 }