    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

    //! The unsafe `close` for raw file descriptors.
    //!
    //! # Safety
    //!
    //! Operating on raw file descriptors is unsafe.
    #![allow(unsafe_code)]

    use crate::backend;
    use backend::fd::RawFd;

    /// `close(raw_fd)`—Closes a `RawFd` directly.
    ///
    /// Most users won't need to use this, as `OwnedFd` automatically closes its
    /// file descriptor on `Drop`.
    ///
    /// This function does not return a `Result`, as it is the [responsibility] of
    /// filesystem designers to not return errors from `close`. Users who chose to
    /// use NFS or similar filesystems should take care to monitor for problems
    /// externally.
    ///
    /// [responsibility]: https://lwn.net/Articles/576518/
    ///
    /// # References
    ///  - [POSIX]
    ///  - [Linux]
    ///  - [Apple]
    ///  - [Winsock2]
    ///
    /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/close.html
    /// [Linux]: https://man7.org/linux/man-pages/man2/close.2.html
    /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/close.2.html#//apple_ref/doc/man/2/close
    /// [Winsock2]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-closesocket
    ///
    /// # Safety
    ///
    /// This function takes a `RawFd`, which must be valid before the call, and is
    /// not valid after the call.
    #[inline]
    pub unsafe fn close(raw_fd: RawFd) {
        backend::io::syscalls::close(raw_fd)
    }