      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

    // 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.

    //! Unix-specific extensions to general I/O primitives

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

    use fs;
    use os::raw;
    use sys;
    use io;
    use sys_common::{AsInner, FromInner, IntoInner};
    use libc;

    /// Raw file descriptors.
    #[stable(feature = "rust1", since = "1.0.0")]
    pub type RawFd = raw::c_int;

    /// A trait to extract the raw unix file descriptor from an underlying
    /// object.
    ///
    /// This is only available on unix platforms and must be imported in order
    /// to call the method. Windows platforms have a corresponding `AsRawHandle`
    /// and `AsRawSocket` set of traits.
    #[stable(feature = "rust1", since = "1.0.0")]
    pub trait AsRawFd {
        /// Extracts the raw file descriptor.
        ///
        /// This method does **not** pass ownership of the raw file descriptor
        /// to the caller. The descriptor is only guaranteed to be valid while
        /// the original object has not yet been destroyed.
        #[stable(feature = "rust1", since = "1.0.0")]
        fn as_raw_fd(&self) -> RawFd;
    }

    /// A trait to express the ability to construct an object from a raw file
    /// descriptor.
    #[stable(feature = "from_raw_os", since = "1.1.0")]
    pub trait FromRawFd {
        /// Constructs a new instance of `Self` from the given raw file
        /// descriptor.
        ///
        /// This function **consumes ownership** of the specified file
        /// descriptor. The returned object will take responsibility for closing
        /// it when the 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_fd(fd: RawFd) -> Self;
    }

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

    #[stable(feature = "rust1", since = "1.0.0")]
    impl AsRawFd for fs::File {
        fn as_raw_fd(&self) -> RawFd {
            self.as_inner().fd().raw()
        }
    }
    #[stable(feature = "from_raw_os", since = "1.1.0")]
    impl FromRawFd for fs::File {
        unsafe fn from_raw_fd(fd: RawFd) -> fs::File {
            fs::File::from_inner(sys::fs::File::from_inner(fd))
        }
    }
    #[stable(feature = "into_raw_os", since = "1.4.0")]
    impl IntoRawFd for fs::File {
        fn into_raw_fd(self) -> RawFd {
            self.into_inner().into_fd().into_raw()
        }
    }

    #[stable(feature = "asraw_stdio", since = "1.21.0")]
    impl AsRawFd for io::Stdin {
        fn as_raw_fd(&self) -> RawFd { libc::STDIN_FILENO }
    }

    #[stable(feature = "asraw_stdio", since = "1.21.0")]
    impl AsRawFd for io::Stdout {
        fn as_raw_fd(&self) -> RawFd { libc::STDOUT_FILENO }
    }

    #[stable(feature = "asraw_stdio", since = "1.21.0")]
    impl AsRawFd for io::Stderr {
        fn as_raw_fd(&self) -> RawFd { libc::STDERR_FILENO }
    }

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