<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source to the Rust file `libstd/sys/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10"> 10</span> <span id="11"> 11</span> <span id="12"> 12</span> <span id="13"> 13</span> <span id="14"> 14</span> <span id="15"> 15</span> <span id="16"> 16</span> <span id="17"> 17</span> <span id="18"> 18</span> <span id="19"> 19</span> <span id="20"> 20</span> <span id="21"> 21</span> <span id="22"> 22</span> <span id="23"> 23</span> <span id="24"> 24</span> <span id="25"> 25</span> <span id="26"> 26</span> <span id="27"> 27</span> <span id="28"> 28</span> <span id="29"> 29</span> <span id="30"> 30</span> <span id="31"> 31</span> <span id="32"> 32</span> <span id="33"> 33</span> <span id="34"> 34</span> <span id="35"> 35</span> <span id="36"> 36</span> <span id="37"> 37</span> <span id="38"> 38</span> <span id="39"> 39</span> <span id="40"> 40</span> <span id="41"> 41</span> <span id="42"> 42</span> <span id="43"> 43</span> <span id="44"> 44</span> <span id="45"> 45</span> <span id="46"> 46</span> <span id="47"> 47</span> <span id="48"> 48</span> <span id="49"> 49</span> <span id="50"> 50</span> <span id="51"> 51</span> <span id="52"> 52</span> <span id="53"> 53</span> <span id="54"> 54</span> <span id="55"> 55</span> <span id="56"> 56</span> <span id="57"> 57</span> <span id="58"> 58</span> <span id="59"> 59</span> <span id="60"> 60</span> <span id="61"> 61</span> <span id="62"> 62</span> <span id="63"> 63</span> <span id="64"> 64</span> <span id="65"> 65</span> <span id="66"> 66</span> <span id="67"> 67</span> <span id="68"> 68</span> <span id="69"> 69</span> <span id="70"> 70</span> <span id="71"> 71</span> <span id="72"> 72</span> <span id="73"> 73</span> <span id="74"> 74</span> <span id="75"> 75</span> <span id="76"> 76</span> <span id="77"> 77</span> <span id="78"> 78</span> <span id="79"> 79</span> <span id="80"> 80</span> <span id="81"> 81</span> <span id="82"> 82</span> <span id="83"> 83</span> <span id="84"> 84</span> <span id="85"> 85</span> <span id="86"> 86</span> <span id="87"> 87</span> <span id="88"> 88</span> <span id="89"> 89</span> <span id="90"> 90</span> <span id="91"> 91</span> <span id="92"> 92</span> <span id="93"> 93</span> <span id="94"> 94</span> <span id="95"> 95</span> <span id="96"> 96</span> <span id="97"> 97</span> <span id="98"> 98</span> <span id="99"> 99</span> <span id="100">100</span> <span id="101">101</span> <span id="102">102</span> </pre><pre class="rust "> <span class="comment">// Copyright 2016 The Rust Project Developers. See the COPYRIGHT</span> <span class="comment">// file at the top-level directory of this distribution and at</span> <span class="comment">// http://rust-lang.org/COPYRIGHT.</span> <span class="comment">//</span> <span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span> <span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span> <span class="comment">// option. This file may not be copied, modified, or distributed</span> <span class="comment">// except according to those terms.</span> <span class="doccomment">//! Platform-dependent platform abstraction</span> <span class="doccomment">//!</span> <span class="doccomment">//! The `std::sys` module is the abstracted interface through which</span> <span class="doccomment">//! `std` talks to the underlying operating system. It has different</span> <span class="doccomment">//! implementations for different operating system families, today</span> <span class="doccomment">//! just Unix and Windows, and initial support for Redox.</span> <span class="doccomment">//!</span> <span class="doccomment">//! The centralization of platform-specific code in this module is</span> <span class="doccomment">//! enforced by the "platform abstraction layer" tidy script in</span> <span class="doccomment">//! `tools/tidy/src/pal.rs`.</span> <span class="doccomment">//!</span> <span class="doccomment">//! This module is closely related to the platform-independent system</span> <span class="doccomment">//! integration code in `std::sys_common`. See that module's</span> <span class="doccomment">//! documentation for details.</span> <span class="doccomment">//!</span> <span class="doccomment">//! In the future it would be desirable for the independent</span> <span class="doccomment">//! implementations of this module to be extracted to their own crates</span> <span class="doccomment">//! that `std` can link to, thus enabling their implementation</span> <span class="doccomment">//! out-of-tree via crate replacement. Though due to the complex</span> <span class="doccomment">//! inter-dependencies within `std` that will be a challenging goal to</span> <span class="doccomment">//! achieve.</span> <span class="attribute">#![<span class="ident">allow</span>(<span class="ident">missing_debug_implementations</span>)]</span> <span class="macro">cfg_if</span><span class="macro">!</span> { <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> { <span class="kw">mod</span> <span class="ident">unix</span>; <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">unix</span>::<span class="kw-2">*</span>; } <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span> { <span class="kw">mod</span> <span class="ident">windows</span>; <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">windows</span>::<span class="kw-2">*</span>; } <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"cloudabi"</span>)]</span> { <span class="kw">mod</span> <span class="ident">cloudabi</span>; <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">cloudabi</span>::<span class="kw-2">*</span>; } <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"redox"</span>)]</span> { <span class="kw">mod</span> <span class="ident">redox</span>; <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">redox</span>::<span class="kw-2">*</span>; } <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>)]</span> { <span class="kw">mod</span> <span class="ident">wasm</span>; <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">wasm</span>::<span class="kw-2">*</span>; } <span class="kw">else</span> { <span class="macro">compile_error</span><span class="macro">!</span>(<span class="string">"libstd doesn't compile for this platform yet"</span>); } } <span class="comment">// Import essential modules from both platforms when documenting. These are</span> <span class="comment">// then later used in the `std::os` module when documenting, for example,</span> <span class="comment">// Windows when we're compiling for Linux.</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">dox</span>)]</span> <span class="macro">cfg_if</span><span class="macro">!</span> { <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"redox"</span>))]</span> { <span class="comment">// On unix we'll document what's already available</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">ext</span> <span class="kw">as</span> <span class="ident">unix_ext</span>; } <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"cloudabi"</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>))]</span> { <span class="comment">// On CloudABI and wasm right now the module below doesn't compile</span> <span class="comment">// (missing things in `libc` which is empty) so just omit everything</span> <span class="comment">// with an empty module</span> <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"std_internals"</span>)]</span> <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">unix_ext</span> {} } <span class="kw">else</span> { <span class="comment">// On other platforms like Windows document the bare bones of unix</span> <span class="kw">use</span> <span class="ident">os</span>::<span class="ident">linux</span> <span class="kw">as</span> <span class="ident">platform</span>; <span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"unix/ext/mod.rs"</span>]</span> <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">unix_ext</span>; } } <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">dox</span>)]</span> <span class="macro">cfg_if</span><span class="macro">!</span> { <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span> { <span class="comment">// On windows we'll just be documenting what's already available</span> <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">ext</span> <span class="kw">as</span> <span class="ident">windows_ext</span>; } <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"cloudabi"</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>))]</span> { <span class="comment">// On CloudABI and wasm right now the shim below doesn't compile, so</span> <span class="comment">// just omit it</span> <span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">issue</span> <span class="op">=</span> <span class="string">"0"</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"std_internals"</span>)]</span> <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">windows_ext</span> {} } <span class="kw">else</span> { <span class="comment">// On all other platforms (aka linux/osx/etc) then pull in a "minimal"</span> <span class="comment">// amount of windows goop which ends up compiling</span> <span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"windows/compat.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">compat</span>; <span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"windows/c.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">c</span>; <span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"windows/ext/mod.rs"</span>]</span> <span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">windows_ext</span>; } } </pre> </section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "std";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>