mod.rs.html -- source
Description: Source to the Rust file `src/libstd/net/mod.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122

    //! Networking primitives for TCP/UDP communication.
    //!
    //! This module provides networking functionality for the Transmission Control and User
    //! Datagram Protocols, as well as types for IP and socket addresses.
    //!
    //! # Organization
    //!
    //! * [`TcpListener`] and [`TcpStream`] provide functionality for communication over TCP
    //! * [`UdpSocket`] provides functionality for communication over UDP
    //! * [`IpAddr`] represents IP addresses of either IPv4 or IPv6; [`Ipv4Addr`] and
    //!   [`Ipv6Addr`] are respectively IPv4 and IPv6 addresses
    //! * [`SocketAddr`] represents socket addresses of either IPv4 or IPv6; [`SocketAddrV4`]
    //!   and [`SocketAddrV6`] are respectively IPv4 and IPv6 socket addresses
    //! * [`ToSocketAddrs`] is a trait that used for generic address resolution when interacting
    //!   with networking objects like [`TcpListener`], [`TcpStream`] or [`UdpSocket`]
    //! * Other types are return or parameter types for various methods in this module
    //!
    //! [`IpAddr`]: ../../std/net/enum.IpAddr.html
    //! [`Ipv4Addr`]: ../../std/net/struct.Ipv4Addr.html
    //! [`Ipv6Addr`]: ../../std/net/struct.Ipv6Addr.html
    //! [`SocketAddr`]: ../../std/net/enum.SocketAddr.html
    //! [`SocketAddrV4`]: ../../std/net/struct.SocketAddrV4.html
    //! [`SocketAddrV6`]: ../../std/net/struct.SocketAddrV6.html
    //! [`TcpListener`]: ../../std/net/struct.TcpListener.html
    //! [`TcpStream`]: ../../std/net/struct.TcpStream.html
    //! [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html
    //! [`UdpSocket`]: ../../std/net/struct.UdpSocket.html

    #![stable(feature = "rust1", since = "1.0.0")]

    use io::{self, Error, ErrorKind};

    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::ip::{IpAddr, Ipv4Addr, Ipv6Addr, Ipv6MulticastScope};
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::addr::{SocketAddr, SocketAddrV4, SocketAddrV6, ToSocketAddrs};
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::tcp::{TcpStream, TcpListener, Incoming};
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::udp::UdpSocket;
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use self::parser::AddrParseError;

    mod ip;
    mod addr;
    mod tcp;
    mod udp;
    mod parser;
    #[cfg(test)]
    mod test;

    /// Possible values which can be passed to the [`shutdown`] method of
    /// [`TcpStream`].
    ///
    /// [`shutdown`]: struct.TcpStream.html#method.shutdown
    /// [`TcpStream`]: struct.TcpStream.html
    #[derive(Copy, Clone, PartialEq, Eq, Debug)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub enum Shutdown {
        /// The reading portion of the [`TcpStream`] should be shut down.
        ///
        /// All currently blocked and future [reads] will return [`Ok(0)`].
        ///
        /// [`TcpStream`]: ../../std/net/struct.TcpStream.html
        /// [reads]: ../../std/io/trait.Read.html
        /// [`Ok(0)`]: ../../std/result/enum.Result.html#variant.Ok
        #[stable(feature = "rust1", since = "1.0.0")]
        Read,
        /// The writing portion of the [`TcpStream`] should be shut down.
        ///
        /// All currently blocked and future [writes] will return an error.
        ///
        /// [`TcpStream`]: ../../std/net/struct.TcpStream.html
        /// [writes]: ../../std/io/trait.Write.html
        #[stable(feature = "rust1", since = "1.0.0")]
        Write,
        /// Both the reading and the writing portions of the [`TcpStream`] should be shut down.
        ///
        /// See [`Shutdown::Read`] and [`Shutdown::Write`] for more information.
        ///
        /// [`TcpStream`]: ../../std/net/struct.TcpStream.html
        /// [`Shutdown::Read`]: #variant.Read
        /// [`Shutdown::Write`]: #variant.Write
        #[stable(feature = "rust1", since = "1.0.0")]
        Both,
    }

    #[doc(hidden)]
    trait NetInt {
        fn from_be(i: Self) -> Self;
        fn to_be(&self) -> Self;
    }
    macro_rules! doit {
        ($($t:ident)*) => ($(impl NetInt for $t {
            fn from_be(i: Self) -> Self { <$t>::from_be(i) }
            fn to_be(&self) -> Self { <$t>::to_be(*self) }
        })*)
    }
    doit! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }

    fn hton<I: NetInt>(i: I) -> I { i.to_be() }
    fn ntoh<I: NetInt>(i: I) -> I { I::from_be(i) }

    fn each_addr<A: ToSocketAddrs, F, T>(addr: A, mut f: F) -> io::Result<T>
        where F: FnMut(io::Result<&SocketAddr>) -> io::Result<T>
    {
        let addrs = match addr.to_socket_addrs() {
            Ok(addrs) => addrs,
            Err(e) => return f(Err(e))
        };
        let mut last_err = None;
        for addr in addrs {
            match f(Ok(&addr)) {
                Ok(l) => return Ok(l),
                Err(e) => last_err = Some(e),
            }
        }
        Err(last_err.unwrap_or_else(|| {
            Error::new(ErrorKind::InvalidInput,
                       "could not resolve to any addresses")
        }))
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)