library/std/src/sys/unix/ext/mod.rs

//! Platform-specific extensions to `std` for Unix platforms.
//!
//! Provides access to platform-level information on Unix platforms, and
//! exposes Unix-specific functions that would otherwise be inappropriate as
//! part of the core `std` library.
//!
//! It exposes more ways to deal with platform-specific strings (`OsStr`,
//! `OsString`), allows to set permissions more granularly, extract low-level
//! file descriptors from files and sockets, and has platform-specific helpers
//! for spawning processes.
//!
//! # Examples
//!
//! ```no_run
//! use std::fs::File;
//! use std::os::unix::prelude::*;
//!
//! fn main() -> std::io::Result<()> {
//!     let f = File::create("foo.txt")?;
//!     let fd = f.as_raw_fd();
//!
//!     // use fd with native unix bindings
//!
//!     Ok(())
//! }
//! ```

#![stable(feature = "rust1", since = "1.0.0")]
#![doc(cfg(unix))]
#![allow(missing_docs)]

cfg_if::cfg_if! {
    if #[cfg(doc)] {
        // Use linux as the default platform when documenting on other platforms like Windows
        use crate::os::linux as platform;
    } else {
        #[cfg(target_os = "android")]
        use crate::os::android as platform;
        #[cfg(target_os = "dragonfly")]
        use crate::os::dragonfly as platform;
        #[cfg(target_os = "emscripten")]
        use crate::os::emscripten as platform;
        #[cfg(target_os = "freebsd")]
        use crate::os::freebsd as platform;
        #[cfg(target_os = "fuchsia")]
        use crate::os::fuchsia as platform;
        #[cfg(target_os = "haiku")]
        use crate::os::haiku as platform;
        #[cfg(target_os = "illumos")]
        use crate::os::illumos as platform;
        #[cfg(target_os = "ios")]
        use crate::os::ios as platform;
        #[cfg(any(target_os = "linux", target_os = "l4re"))]
        use crate::os::linux as platform;
        #[cfg(target_os = "macos")]
        use crate::os::macos as platform;
        #[cfg(target_os = "netbsd")]
        use crate::os::netbsd as platform;
        #[cfg(target_os = "openbsd")]
        use crate::os::openbsd as platform;
        #[cfg(target_os = "redox")]
        use crate::os::redox as platform;
        #[cfg(target_os = "solaris")]
        use crate::os::solaris as platform;
        #[cfg(target_os = "vxworks")]
        use crate::os::vxworks as platform;
    }
}

pub mod ffi;
pub mod fs;
pub mod io;
pub mod net;
pub mod process;
pub mod raw;
pub mod thread;

#[unstable(feature = "peer_credentials_unix_socket", issue = "42839", reason = "unstable")]
#[cfg(any(
    target_os = "android",
    target_os = "linux",
    target_os = "dragonfly",
    target_os = "freebsd",
    target_os = "ios",
    target_os = "macos",
    target_os = "openbsd"
))]
pub mod ucred;

/// A prelude for conveniently writing platform-specific code.
///
/// Includes all extension traits, and some important type definitions.
#[stable(feature = "rust1", since = "1.0.0")]
pub mod prelude {
    #[doc(no_inline)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use super::ffi::{OsStrExt, OsStringExt};
    #[doc(no_inline)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use super::fs::DirEntryExt;
    #[doc(no_inline)]
    #[stable(feature = "file_offset", since = "1.15.0")]
    pub use super::fs::FileExt;
    #[doc(no_inline)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use super::fs::{FileTypeExt, MetadataExt, OpenOptionsExt, PermissionsExt};
    #[doc(no_inline)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use super::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
    #[doc(no_inline)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use super::process::{CommandExt, ExitStatusExt};
    #[doc(no_inline)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub use super::thread::JoinHandleExt;
}