1b8a62b91Sopenharmony_ci//! The unsafe `close` for raw file descriptors. 2b8a62b91Sopenharmony_ci//! 3b8a62b91Sopenharmony_ci//! # Safety 4b8a62b91Sopenharmony_ci//! 5b8a62b91Sopenharmony_ci//! Operating on raw file descriptors is unsafe. 6b8a62b91Sopenharmony_ci#![allow(unsafe_code)] 7b8a62b91Sopenharmony_ci 8b8a62b91Sopenharmony_ciuse crate::backend; 9b8a62b91Sopenharmony_ciuse backend::fd::RawFd; 10b8a62b91Sopenharmony_ci 11b8a62b91Sopenharmony_ci/// `close(raw_fd)`—Closes a `RawFd` directly. 12b8a62b91Sopenharmony_ci/// 13b8a62b91Sopenharmony_ci/// Most users won't need to use this, as `OwnedFd` automatically closes its 14b8a62b91Sopenharmony_ci/// file descriptor on `Drop`. 15b8a62b91Sopenharmony_ci/// 16b8a62b91Sopenharmony_ci/// This function does not return a `Result`, as it is the [responsibility] of 17b8a62b91Sopenharmony_ci/// filesystem designers to not return errors from `close`. Users who chose to 18b8a62b91Sopenharmony_ci/// use NFS or similar filesystems should take care to monitor for problems 19b8a62b91Sopenharmony_ci/// externally. 20b8a62b91Sopenharmony_ci/// 21b8a62b91Sopenharmony_ci/// [responsibility]: https://lwn.net/Articles/576518/ 22b8a62b91Sopenharmony_ci/// 23b8a62b91Sopenharmony_ci/// # References 24b8a62b91Sopenharmony_ci/// - [POSIX] 25b8a62b91Sopenharmony_ci/// - [Linux] 26b8a62b91Sopenharmony_ci/// - [Apple] 27b8a62b91Sopenharmony_ci/// - [Winsock2] 28b8a62b91Sopenharmony_ci/// 29b8a62b91Sopenharmony_ci/// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/close.html 30b8a62b91Sopenharmony_ci/// [Linux]: https://man7.org/linux/man-pages/man2/close.2.html 31b8a62b91Sopenharmony_ci/// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/close.2.html#//apple_ref/doc/man/2/close 32b8a62b91Sopenharmony_ci/// [Winsock2]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-closesocket 33b8a62b91Sopenharmony_ci/// 34b8a62b91Sopenharmony_ci/// # Safety 35b8a62b91Sopenharmony_ci/// 36b8a62b91Sopenharmony_ci/// This function takes a `RawFd`, which must be valid before the call, and is 37b8a62b91Sopenharmony_ci/// not valid after the call. 38b8a62b91Sopenharmony_ci#[inline] 39b8a62b91Sopenharmony_cipub unsafe fn close(raw_fd: RawFd) { 40b8a62b91Sopenharmony_ci backend::io::syscalls::close(raw_fd) 41b8a62b91Sopenharmony_ci} 42