1 //! Platform-dependent platform abstraction.
3 //! The `std::sys` module is the abstracted interface through which
4 //! `std` talks to the underlying operating system. It has different
5 //! implementations for different operating system families, today
6 //! just Unix and Windows, and initial support for Redox.
8 //! The centralization of platform-specific code in this module is
9 //! enforced by the "platform abstraction layer" tidy script in
10 //! `tools/tidy/src/pal.rs`.
12 //! This module is closely related to the platform-independent system
13 //! integration code in `std::sys_common`. See that module's
14 //! documentation for details.
16 //! In the future it would be desirable for the independent
17 //! implementations of this module to be extracted to their own crates
18 //! that `std` can link to, thus enabling their implementation
19 //! out-of-tree via crate replacement. Though due to the complex
20 //! inter-dependencies within `std` that will be a challenging goal to
23 #![allow(missing_debug_implementations)]
30 pub use self::unix::*;
31 } else if #[cfg(windows)] {
33 pub use self::windows::*;
34 } else if #[cfg(target_os = "hermit")] {
36 pub use self::hermit::*;
37 } else if #[cfg(target_os = "wasi")] {
39 pub use self::wasi::*;
40 } else if #[cfg(target_arch = "wasm32")] {
42 pub use self::wasm::*;
43 } else if #[cfg(all(target_vendor = "fortanix", target_env = "sgx"))] {
48 pub use self::unsupported::*;
52 // Import essential modules from both platforms when documenting. These are
53 // then later used in the `std::os` module when documenting, for example,
54 // Windows when we're compiling for Linux.
59 // On unix we'll document what's already available
60 #[stable(feature = "rust1", since = "1.0.0")]
61 pub use self::ext as unix_ext;
62 } else if #[cfg(any(target_os = "hermit",
63 all(target_arch = "wasm32", not(target_os = "wasi")),
64 all(target_vendor = "fortanix", target_env = "sgx")))] {
65 // On non-WASI wasm right now the module below doesn't compile
66 // (missing things in `libc` which is empty) so just omit everything
67 // with an empty module
68 #[unstable(issue = "none", feature = "std_internals")]
69 #[allow(missing_docs)]
72 #[path = "unix/ext/mod.rs"]
80 // On windows we'll just be documenting what's already available
81 #[allow(missing_docs)]
82 #[stable(feature = "rust1", since = "1.0.0")]
83 pub use self::ext as windows_ext;
84 } else if #[cfg(any(target_os = "hermit",
85 all(target_arch = "wasm32", not(target_os = "wasi")),
86 all(target_vendor = "fortanix", target_env = "sgx")))] {
87 // On non-WASI wasm right now the shim below doesn't compile, so
89 #[unstable(issue = "none", feature = "std_internals")]
90 #[allow(missing_docs)]
91 pub mod windows_ext {}
93 // On all other platforms (aka linux/osx/etc) then pull in a "minimal"
94 // amount of windows goop which ends up compiling
96 #[path = "windows/compat.rs"]
99 #[path = "windows/c.rs"]
102 #[path = "windows/ext/mod.rs"]
109 if #[cfg(target_os = "wasi")] {
110 // On WASI we'll document what's already available
111 #[stable(feature = "wasi_ext_doc", since = "1.35.0")]
112 pub use self::ext as wasi_ext;
113 } else if #[cfg(any(target_os = "hermit",
114 target_arch = "wasm32",
115 all(target_vendor = "fortanix", target_env = "sgx")))] {
116 // On non-WASI wasm right now the module below doesn't compile
117 // (missing things in `libc` which is empty) so just omit everything
118 // with an empty module
119 #[unstable(issue = "none", feature = "std_internals")]
120 #[allow(missing_docs)]
123 // On other platforms like Windows document the bare bones of WASI
124 #[path = "wasi/ext/mod.rs"]
125 #[stable(feature = "wasi_ext_doc", since = "1.35.0")]