      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
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209

    // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

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

    use fs;
    use os::windows::raw;
    use net;
    use sys_common::{self, AsInner, FromInner, IntoInner};
    use sys;
    use io;
    use sys::c;

    /// Raw HANDLEs.
    #[stable(feature = "rust1", since = "1.0.0")]
    pub type RawHandle = raw::HANDLE;

    /// Raw SOCKETs.
    #[stable(feature = "rust1", since = "1.0.0")]
    pub type RawSocket = raw::SOCKET;

    /// Extract raw handles.
    #[stable(feature = "rust1", since = "1.0.0")]
    pub trait AsRawHandle {
        /// Extracts the raw handle, without taking any ownership.
        #[stable(feature = "rust1", since = "1.0.0")]
        fn as_raw_handle(&self) -> RawHandle;
    }

    /// Construct I/O objects from raw handles.
    #[stable(feature = "from_raw_os", since = "1.1.0")]
    pub trait FromRawHandle {
        /// Constructs a new I/O object from the specified raw handle.
        ///
        /// This function will **consume ownership** of the handle given,
        /// passing responsibility for closing the handle to the returned
        /// object.
        ///
        /// This function is also unsafe as the primitives currently returned
        /// have the contract that they are the sole owner of the file
        /// descriptor they are wrapping. Usage of this function could
        /// accidentally allow violating this contract which can cause memory
        /// unsafety in code that relies on it being true.
        #[stable(feature = "from_raw_os", since = "1.1.0")]
        unsafe fn from_raw_handle(handle: RawHandle) -> Self;
    }

    /// A trait to express the ability to consume an object and acquire ownership of
    /// its raw `HANDLE`.
    #[stable(feature = "into_raw_os", since = "1.4.0")]
    pub trait IntoRawHandle {
        /// Consumes this object, returning the raw underlying handle.
        ///
        /// This function **transfers ownership** of the underlying handle to the
        /// caller. Callers are then the unique owners of the handle and must close
        /// it once it's no longer needed.
        #[stable(feature = "into_raw_os", since = "1.4.0")]
        fn into_raw_handle(self) -> RawHandle;
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl AsRawHandle for fs::File {
        fn as_raw_handle(&self) -> RawHandle {
            self.as_inner().handle().raw() as RawHandle
        }
    }

    #[stable(feature = "asraw_stdio", since = "1.21.0")]
    impl AsRawHandle for io::Stdin {
        fn as_raw_handle(&self) -> RawHandle {
            unsafe { c::GetStdHandle(c::STD_INPUT_HANDLE) as RawHandle }
        }
    }

    #[stable(feature = "asraw_stdio", since = "1.21.0")]
    impl AsRawHandle for io::Stdout {
        fn as_raw_handle(&self) -> RawHandle {
            unsafe { c::GetStdHandle(c::STD_OUTPUT_HANDLE) as RawHandle }
        }
    }

    #[stable(feature = "asraw_stdio", since = "1.21.0")]
    impl AsRawHandle for io::Stderr {
        fn as_raw_handle(&self) -> RawHandle {
            unsafe { c::GetStdHandle(c::STD_ERROR_HANDLE) as RawHandle }
        }
    }

    #[stable(feature = "from_raw_os", since = "1.1.0")]
    impl FromRawHandle for fs::File {
        unsafe fn from_raw_handle(handle: RawHandle) -> fs::File {
            let handle = handle as c::HANDLE;
            fs::File::from_inner(sys::fs::File::from_inner(handle))
        }
    }

    #[stable(feature = "into_raw_os", since = "1.4.0")]
    impl IntoRawHandle for fs::File {
        fn into_raw_handle(self) -> RawHandle {
            self.into_inner().into_handle().into_raw() as *mut _
        }
    }

    /// Extract raw sockets.
    #[stable(feature = "rust1", since = "1.0.0")]
    pub trait AsRawSocket {
        /// Extracts the underlying raw socket from this object.
        #[stable(feature = "rust1", since = "1.0.0")]
        fn as_raw_socket(&self) -> RawSocket;
    }

    /// Create I/O objects from raw sockets.
    #[stable(feature = "from_raw_os", since = "1.1.0")]
    pub trait FromRawSocket {
        /// Creates a new I/O object from the given raw socket.
        ///
        /// This function will **consume ownership** of the socket provided and
        /// it will be closed when the returned object goes out of scope.
        ///
        /// This function is also unsafe as the primitives currently returned
        /// have the contract that they are the sole owner of the file
        /// descriptor they are wrapping. Usage of this function could
        /// accidentally allow violating this contract which can cause memory
        /// unsafety in code that relies on it being true.
        #[stable(feature = "from_raw_os", since = "1.1.0")]
        unsafe fn from_raw_socket(sock: RawSocket) -> Self;
    }

    /// A trait to express the ability to consume an object and acquire ownership of
    /// its raw `SOCKET`.
    #[stable(feature = "into_raw_os", since = "1.4.0")]
    pub trait IntoRawSocket {
        /// Consumes this object, returning the raw underlying socket.
        ///
        /// This function **transfers ownership** of the underlying socket to the
        /// caller. Callers are then the unique owners of the socket and must close
        /// it once it's no longer needed.
        #[stable(feature = "into_raw_os", since = "1.4.0")]
        fn into_raw_socket(self) -> RawSocket;
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl AsRawSocket for net::TcpStream {
        fn as_raw_socket(&self) -> RawSocket {
            *self.as_inner().socket().as_inner()
        }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl AsRawSocket for net::TcpListener {
        fn as_raw_socket(&self) -> RawSocket {
            *self.as_inner().socket().as_inner()
        }
    }
    #[stable(feature = "rust1", since = "1.0.0")]
    impl AsRawSocket for net::UdpSocket {
        fn as_raw_socket(&self) -> RawSocket {
            *self.as_inner().socket().as_inner()
        }
    }

    #[stable(feature = "from_raw_os", since = "1.1.0")]
    impl FromRawSocket for net::TcpStream {
        unsafe fn from_raw_socket(sock: RawSocket) -> net::TcpStream {
            let sock = sys::net::Socket::from_inner(sock);
            net::TcpStream::from_inner(sys_common::net::TcpStream::from_inner(sock))
        }
    }
    #[stable(feature = "from_raw_os", since = "1.1.0")]
    impl FromRawSocket for net::TcpListener {
        unsafe fn from_raw_socket(sock: RawSocket) -> net::TcpListener {
            let sock = sys::net::Socket::from_inner(sock);
            net::TcpListener::from_inner(sys_common::net::TcpListener::from_inner(sock))
        }
    }
    #[stable(feature = "from_raw_os", since = "1.1.0")]
    impl FromRawSocket for net::UdpSocket {
        unsafe fn from_raw_socket(sock: RawSocket) -> net::UdpSocket {
            let sock = sys::net::Socket::from_inner(sock);
            net::UdpSocket::from_inner(sys_common::net::UdpSocket::from_inner(sock))
        }
    }

    #[stable(feature = "into_raw_os", since = "1.4.0")]
    impl IntoRawSocket for net::TcpStream {
        fn into_raw_socket(self) -> RawSocket {
            self.into_inner().into_socket().into_inner()
        }
    }

    #[stable(feature = "into_raw_os", since = "1.4.0")]
    impl IntoRawSocket for net::TcpListener {
        fn into_raw_socket(self) -> RawSocket {
            self.into_inner().into_socket().into_inner()
        }
    }

    #[stable(feature = "into_raw_os", since = "1.4.0")]
    impl IntoRawSocket for net::UdpSocket {
        fn into_raw_socket(self) -> RawSocket {
            self.into_inner().into_socket().into_inner()
        }
    }

# 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`)