io.rs - source
Description: Source of the Rust file `library/std/src/sys/unix/ext/io.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
    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

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

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

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

    /// 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.
        ///
        /// # Example
        ///
        /// ```no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use std::os::unix::io::{AsRawFd, RawFd};
        ///
        /// let mut f = File::open("foo.txt")?;
        /// // Note that `raw_fd` is only valid as long as `f` exists.
        /// let raw_fd: RawFd = f.as_raw_fd();
        /// # Ok::<(), io::Error>(())
        /// ```
        #[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.
        ///
        /// # Example
        ///
        /// ```no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use std::os::unix::io::{FromRawFd, IntoRawFd, RawFd};
        ///
        /// let f = File::open("foo.txt")?;
        /// let raw_fd: RawFd = f.into_raw_fd();
        /// // SAFETY: no other functions should call `from_raw_fd`, so there
        /// // is only one owner for the file descriptor.
        /// let f = unsafe { File::from_raw_fd(raw_fd) };
        /// # Ok::<(), io::Error>(())
        /// ```
        #[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.
        ///
        /// # Example
        ///
        /// ```no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use std::os::unix::io::{IntoRawFd, RawFd};
        ///
        /// let f = File::open("foo.txt")?;
        /// let raw_fd: RawFd = f.into_raw_fd();
        /// # Ok::<(), io::Error>(())
        /// ```
        #[stable(feature = "into_raw_os", since = "1.4.0")]
        fn into_raw_fd(self) -> RawFd;
    }

    #[stable(feature = "raw_fd_reflexive_traits", since = "1.48.0")]
    impl AsRawFd for RawFd {
        fn as_raw_fd(&self) -> RawFd {
            *self
        }
    }
    #[stable(feature = "raw_fd_reflexive_traits", since = "1.48.0")]
    impl IntoRawFd for RawFd {
        fn into_raw_fd(self) -> RawFd {
            self
        }
    }
    #[stable(feature = "raw_fd_reflexive_traits", since = "1.48.0")]
    impl FromRawFd for RawFd {
        unsafe fn from_raw_fd(fd: RawFd) -> RawFd {
            fd
        }
    }

    #[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
        }
    }

    #[stable(feature = "asraw_stdio_locks", since = "1.35.0")]
    impl<'a> AsRawFd for io::StdinLock<'a> {
        fn as_raw_fd(&self) -> RawFd {
            libc::STDIN_FILENO
        }
    }

    #[stable(feature = "asraw_stdio_locks", since = "1.35.0")]
    impl<'a> AsRawFd for io::StdoutLock<'a> {
        fn as_raw_fd(&self) -> RawFd {
            libc::STDOUT_FILENO
        }
    }

    #[stable(feature = "asraw_stdio_locks", since = "1.35.0")]
    impl<'a> AsRawFd for io::StderrLock<'a> {
        fn as_raw_fd(&self) -> RawFd {
            libc::STDERR_FILENO
        }
    }