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.
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.
11 //! Networking primitives for TCP/UDP communication.
13 #![stable(feature = "rust1", since = "1.0.0")]
17 use io
::{self, Error, ErrorKind}
;
18 use sys_common
::net
as net_imp
;
20 #[stable(feature = "rust1", since = "1.0.0")]
21 pub use self::ip
::{IpAddr, Ipv4Addr, Ipv6Addr, Ipv6MulticastScope}
;
22 #[stable(feature = "rust1", since = "1.0.0")]
23 pub use self::addr
::{SocketAddr, SocketAddrV4, SocketAddrV6, ToSocketAddrs}
;
24 #[stable(feature = "rust1", since = "1.0.0")]
25 pub use self::tcp
::{TcpStream, TcpListener, Incoming}
;
26 #[stable(feature = "rust1", since = "1.0.0")]
27 pub use self::udp
::UdpSocket
;
28 #[stable(feature = "rust1", since = "1.0.0")]
29 pub use self::parser
::AddrParseError
;
36 #[cfg(test)] mod test;
38 /// Possible values which can be passed to the [`shutdown`] method of
41 /// [`shutdown`]: struct.TcpStream.html#method.shutdown
42 /// [`TcpStream`]: struct.TcpStream.html
43 #[derive(Copy, Clone, PartialEq, Debug)]
44 #[stable(feature = "rust1", since = "1.0.0")]
46 /// Indicates that the reading portion of this stream/socket should be shut
47 /// down. All currently blocked and future reads will return `Ok(0)`.
48 #[stable(feature = "rust1", since = "1.0.0")]
50 /// Indicates that the writing portion of this stream/socket should be shut
51 /// down. All currently blocked and future writes will return an error.
52 #[stable(feature = "rust1", since = "1.0.0")]
54 /// Shut down both the reading and writing portions of this stream.
56 /// See `Shutdown::Read` and `Shutdown::Write` for more information.
57 #[stable(feature = "rust1", since = "1.0.0")]
63 fn from_be(i
: Self) -> Self;
64 fn to_be(&self) -> Self;
67 ($
($t
:ident
)*) => ($
(impl NetInt
for $t
{
68 fn from_be(i
: Self) -> Self { <$t>::from_be(i) }
69 fn to_be(&self) -> Self { <$t>::to_be(*self) }
72 doit
! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
74 fn hton
<I
: NetInt
>(i
: I
) -> I { i.to_be() }
75 fn ntoh
<I
: NetInt
>(i
: I
) -> I { I::from_be(i) }
77 fn each_addr
<A
: ToSocketAddrs
, F
, T
>(addr
: A
, mut f
: F
) -> io
::Result
<T
>
78 where F
: FnMut(&SocketAddr
) -> io
::Result
<T
>
80 let mut last_err
= None
;
81 for addr
in addr
.to_socket_addrs()?
{
83 Ok(l
) => return Ok(l
),
84 Err(e
) => last_err
= Some(e
),
87 Err(last_err
.unwrap_or_else(|| {
88 Error
::new(ErrorKind
::InvalidInput
,
89 "could not resolve to any addresses")
93 /// An iterator over `SocketAddr` values returned from a host lookup operation.
94 #[unstable(feature = "lookup_host", reason = "unsure about the returned \
95 iterator and returning socket \
98 pub struct LookupHost(net_imp
::LookupHost
);
100 #[unstable(feature = "lookup_host", reason = "unsure about the returned \
101 iterator and returning socket \
104 impl Iterator
for LookupHost
{
105 type Item
= SocketAddr
;
106 fn next(&mut self) -> Option
<SocketAddr
> { self.0.next() }
109 /// Resolve the host specified by `host` as a number of `SocketAddr` instances.
111 /// This method may perform a DNS query to resolve `host` and may also inspect
112 /// system configuration to resolve the specified hostname.
114 /// The returned iterator will skip over any unknown addresses returned by the
115 /// operating system.
120 /// #![feature(lookup_host)]
124 /// # fn foo() -> std::io::Result<()> {
125 /// for host in try!(net::lookup_host("rust-lang.org")) {
126 /// println!("found address: {}", host);
131 #[unstable(feature = "lookup_host", reason = "unsure about the returned \
132 iterator and returning socket \
135 pub fn lookup_host(host
: &str) -> io
::Result
<LookupHost
> {
136 net_imp
::lookup_host(host
).map(LookupHost
)