blob: 7af2d487b03920819543af5945129ad680de4363 [file] [log] [blame]
<!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 of the Rust file `src/sys/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - 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="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></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" role="button">&#9776;</div><a href='../../../mio/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" height="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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! Module with system specific types.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Required types:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! * `Event`: a type alias for the system specific event, e.g. `kevent` or</span>
<span class="doccomment">//! `epoll_event`.</span>
<span class="doccomment">//! * `event`: a module with various helper functions for `Event`, see</span>
<span class="doccomment">//! [`crate::event::Event`] for the required functions.</span>
<span class="doccomment">//! * `Events`: collection of `Event`s, see [`crate::Events`].</span>
<span class="doccomment">//! * `IoSourceState`: state for the `IoSource` type.</span>
<span class="doccomment">//! * `Selector`: selector used to register event sources and poll for events,</span>
<span class="doccomment">//! see [`crate::Poll`] and [`crate::Registry`] for required</span>
<span class="doccomment">//! methods.</span>
<span class="doccomment">//! * `tcp` and `udp` modules: see the [`crate::net`] module.</span>
<span class="doccomment">//! * `Waker`: see [`crate::Waker`].</span>
<span class="macro">cfg_os_poll</span><span class="macro">!</span> {
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">debug_detail</span> {
(
<span class="macro-nonterminal">$</span><span class="kw">type</span>: <span class="macro-nonterminal">ident</span> (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">event_type</span>: <span class="ident">ty</span>), <span class="macro-nonterminal">$</span><span class="macro-nonterminal">test</span>: <span class="ident">path</span>,
$($(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>: <span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">libc</span>: <span class="ident">ident</span> :: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">flag</span>: <span class="ident">ident</span>),<span class="op">+</span> $(,)<span class="op">*</span>
) <span class="op">=</span><span class="op">&gt;</span> {
<span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="kw">type</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">event_type</span>);
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="macro-nonterminal">$</span><span class="kw">type</span> {
<span class="kw">fn</span> <span class="macro-nonterminal">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op">&lt;</span><span class="lifetime">&#39;_</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">written_one</span> <span class="op">=</span> <span class="bool-val">false</span>;
$(
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>]</span>)<span class="op">*</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">clippy</span>::<span class="ident">bad_bit_mask</span>)]</span> <span class="comment">// Apparently some flags are zero.</span>
{
<span class="comment">// Windows doesn&#39;t use `libc` but the `afd` module.</span>
<span class="kw">if</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">test</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="kw-2">&amp;</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">libc</span> :: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">flag</span>) {
<span class="kw">if</span> <span class="op">!</span><span class="ident">written_one</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">&quot;{}&quot;</span>, <span class="macro">stringify</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">flag</span>))<span class="question-mark">?</span>;
<span class="ident">written_one</span> <span class="op">=</span> <span class="bool-val">true</span>;
} <span class="kw">else</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">&quot;|{}&quot;</span>, <span class="macro">stringify</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">flag</span>))<span class="question-mark">?</span>;
}
}
}
)<span class="op">+</span>
<span class="kw">if</span> <span class="op">!</span><span class="ident">written_one</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">&quot;(empty)&quot;</span>)
} <span class="kw">else</span> {
<span class="prelude-val">Ok</span>(())
}
}
}
};
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span>
<span class="macro">cfg_os_poll</span><span class="macro">!</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="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="macro">cfg_os_poll</span><span class="macro">!</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="macro">cfg_not_os_poll</span><span class="macro">!</span> {
<span class="kw">mod</span> <span class="ident">shell</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use</span> <span class="self">self</span>::<span class="ident">shell</span>::<span class="kw-2">*</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span>
<span class="macro">cfg_any_os_ext</span><span class="macro">!</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="ident">SourceFd</span>;
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span>
<span class="macro">cfg_net</span><span class="macro">!</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">unix</span>::<span class="ident">SocketAddr</span>;
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="mio" data-search-js="../../../search-index.js"></div>
<script src="../../../main.js"></script><script src="../../../source-script.js"></script><script src="../../../source-files.js"></script></body></html>