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)]
28 if #[cfg(target_os = "vxworks")] {
30 pub use self::vxworks::*;
31 } else if #[cfg(unix)] {
33 pub use self::unix::*;
34 } else if #[cfg(windows)] {
36 pub use self::windows::*;
37 } else if #[cfg(target_os = "hermit")] {
39 pub use self::hermit::*;
40 } else if #[cfg(target_os = "wasi")] {
42 pub use self::wasi::*;
43 } else if #[cfg(target_arch = "wasm32")] {
45 pub use self::wasm::*;
46 } else if #[cfg(all(target_vendor = "fortanix", target_env = "sgx"))] {
51 pub use self::unsupported::*;
55 // Import essential modules from both platforms when documenting. These are
56 // then later used in the `std::os` module when documenting, for example,
57 // Windows when we're compiling for Linux.
62 // On unix we'll document what's already available
63 #[stable(feature = "rust1", since = "1.0.0")]
64 pub use self::ext as unix_ext;
65 } else if #[cfg(any(target_os = "hermit",
66 all(target_arch = "wasm32", not(target_os = "wasi")),
67 all(target_vendor = "fortanix", target_env = "sgx")))] {
68 // On non-WASI wasm right now the module below doesn't compile
69 // (missing things in `libc` which is empty) so just omit everything
70 // with an empty module
71 #[unstable(issue = "none", feature = "std_internals")]
72 #[allow(missing_docs)]
75 #[path = "unix/ext/mod.rs"]
83 // On windows we'll just be documenting what's already available
84 #[allow(missing_docs)]
85 #[stable(feature = "rust1", since = "1.0.0")]
86 pub use self::ext as windows_ext;
87 } else if #[cfg(any(target_os = "hermit",
88 all(target_arch = "wasm32", not(target_os = "wasi")),
89 all(target_vendor = "fortanix", target_env = "sgx")))] {
90 // On non-WASI wasm right now the shim below doesn't compile, so
92 #[unstable(issue = "none", feature = "std_internals")]
93 #[allow(missing_docs)]
94 pub mod windows_ext {}
96 // On all other platforms (aka linux/osx/etc) then pull in a "minimal"
97 // amount of windows goop which ends up compiling
99 #[path = "windows/compat.rs"]
102 #[path = "windows/c.rs"]
105 #[path = "windows/ext/mod.rs"]
112 if #[cfg(target_os = "wasi")] {
113 // On WASI we'll document what's already available
114 #[stable(feature = "wasi_ext_doc", since = "1.35.0")]
115 pub use self::ext as wasi_ext;
116 } else if #[cfg(any(target_os = "hermit",
117 target_arch = "wasm32",
118 all(target_vendor = "fortanix", target_env = "sgx")))] {
119 // On non-WASI wasm right now the module below doesn't compile
120 // (missing things in `libc` which is empty) so just omit everything
121 // with an empty module
122 #[unstable(issue = "none", feature = "std_internals")]
123 #[allow(missing_docs)]
126 // On other platforms like Windows document the bare bones of WASI
127 #[path = "wasi/ext/mod.rs"]
128 #[stable(feature = "wasi_ext_doc", since = "1.35.0")]