| <!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/event/event.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>event.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">☰</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> |
| <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> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| </pre><div class="example-wrap"><pre class="rust "> |
| <span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">sys</span>, <span class="ident">Token</span>}; |
| |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>; |
| |
| <span class="doccomment">/// A readiness event.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// `Event` is a readiness state paired with a [`Token`]. It is returned by</span> |
| <span class="doccomment">/// [`Poll::poll`].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// For more documentation on polling and events, see [`Poll`].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`Poll::poll`]: ../struct.Poll.html#method.poll</span> |
| <span class="doccomment">/// [`Poll`]: ../struct.Poll.html</span> |
| <span class="doccomment">/// [`Token`]: ../struct.Token.html</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span> |
| <span class="attribute">#[<span class="ident">repr</span>(<span class="ident">transparent</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Event</span> { |
| <span class="ident">inner</span>: <span class="ident">sys</span>::<span class="ident">Event</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Event</span> { |
| <span class="doccomment">/// Returns the event's token.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">token</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Token</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">token</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains readable readiness.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_readable</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_readable</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains writable readiness.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_writable</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_writable</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains error readiness.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Error events occur when the socket enters an error state. In this case,</span> |
| <span class="doccomment">/// the socket will also receive a readable or writable event. Reading or</span> |
| <span class="doccomment">/// writing to the socket will result in an error.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Method is available on all platforms, but not all platforms trigger the</span> |
| <span class="doccomment">/// error event.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The table below shows what flags are checked on what OS.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// | [OS selector] | Flag(s) checked |</span> |
| <span class="doccomment">/// |---------------|-----------------|</span> |
| <span class="doccomment">/// | [epoll] | `EPOLLERR` |</span> |
| <span class="doccomment">/// | [kqueue] | `EV_ERROR` and `EV_EOF` with `fflags` set to `0`. |</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [OS selector]: ../struct.Poll.html#implementation-notes</span> |
| <span class="doccomment">/// [epoll]: http://man7.org/linux/man-pages/man7/epoll.7.html</span> |
| <span class="doccomment">/// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_error</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_error</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains read closed readiness.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Read closed readiness can be expected after any of the following have</span> |
| <span class="doccomment">/// occurred:</span> |
| <span class="doccomment">/// * The local stream has shutdown the read half of its socket</span> |
| <span class="doccomment">/// * The local stream has shutdown both the read half and the write half</span> |
| <span class="doccomment">/// of its socket</span> |
| <span class="doccomment">/// * The peer stream has shutdown the write half its socket; this sends a</span> |
| <span class="doccomment">/// `FIN` packet that has been received by the local stream</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Method is a best effort implementation. While some platforms may not</span> |
| <span class="doccomment">/// return readiness when read half is closed, it is guaranteed that</span> |
| <span class="doccomment">/// false-positives will not occur.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The table below shows what flags are checked on what OS.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// | [OS selector] | Flag(s) checked |</span> |
| <span class="doccomment">/// |---------------|-----------------|</span> |
| <span class="doccomment">/// | [epoll] | `EPOLLHUP`, or |</span> |
| <span class="doccomment">/// | | `EPOLLIN` and `EPOLLRDHUP` |</span> |
| <span class="doccomment">/// | [kqueue] | `EV_EOF` |</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [OS selector]: ../struct.Poll.html#implementation-notes</span> |
| <span class="doccomment">/// [epoll]: http://man7.org/linux/man-pages/man7/epoll.7.html</span> |
| <span class="doccomment">/// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_read_closed</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_read_closed</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains write closed readiness.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// On [epoll] this is essentially a check for `EPOLLHUP` flag as the</span> |
| <span class="doccomment">/// local stream shutting down its write half does not trigger this event.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// On [kqueue] the local stream shutting down the write half of its</span> |
| <span class="doccomment">/// socket will trigger this event.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Method is a best effort implementation. While some platforms may not</span> |
| <span class="doccomment">/// return readiness when write half is closed, it is guaranteed that</span> |
| <span class="doccomment">/// false-positives will not occur.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The table below shows what flags are checked on what OS.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// | [OS selector] | Flag(s) checked |</span> |
| <span class="doccomment">/// |---------------|-----------------|</span> |
| <span class="doccomment">/// | [epoll] | `EPOLLHUP`, or |</span> |
| <span class="doccomment">/// | | only `EPOLLERR`, or |</span> |
| <span class="doccomment">/// | | `EPOLLOUT` and `EPOLLERR` |</span> |
| <span class="doccomment">/// | [kqueue] | `EV_EOF` |</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [OS selector]: ../struct.Poll.html#implementation-notes</span> |
| <span class="doccomment">/// [epoll]: http://man7.org/linux/man-pages/man7/epoll.7.html</span> |
| <span class="doccomment">/// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_write_closed</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_write_closed</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains priority readiness.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Method is available on all platforms, but not all platforms trigger the</span> |
| <span class="doccomment">/// priority event.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The table below shows what flags are checked on what OS.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// | [OS selector] | Flag(s) checked |</span> |
| <span class="doccomment">/// |---------------|-----------------|</span> |
| <span class="doccomment">/// | [epoll] | `EPOLLPRI` |</span> |
| <span class="doccomment">/// | [kqueue] | *Not supported* |</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [OS selector]: ../struct.Poll.html#implementation-notes</span> |
| <span class="doccomment">/// [epoll]: http://man7.org/linux/man-pages/man7/epoll.7.html</span> |
| <span class="doccomment">/// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2</span> |
| <span class="attribute">#[<span class="ident">inline</span>]</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_priority</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_priority</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains AIO readiness.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Method is available on all platforms, but not all platforms support AIO.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The table below shows what flags are checked on what OS.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// | [OS selector] | Flag(s) checked |</span> |
| <span class="doccomment">/// |---------------|-----------------|</span> |
| <span class="doccomment">/// | [epoll] | *Not supported* |</span> |
| <span class="doccomment">/// | [kqueue]<sup>1</sup> | `EVFILT_AIO` |</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// 1: Only supported on DragonFly BSD, FreeBSD, iOS and macOS.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [OS selector]: ../struct.Poll.html#implementation-notes</span> |
| <span class="doccomment">/// [epoll]: http://man7.org/linux/man-pages/man7/epoll.7.html</span> |
| <span class="doccomment">/// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_aio</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_aio</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Returns true if the event contains LIO readiness.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Notes</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Method is available on all platforms, but only FreeBSD supports LIO. On</span> |
| <span class="doccomment">/// FreeBSD this method checks the `EVFILT_LIO` flag.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_lio</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">is_lio</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) |
| } |
| |
| <span class="doccomment">/// Create a reference to an `Event` from a platform specific event.</span> |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">from_sys_event_ref</span>(<span class="ident">sys_event</span>: <span class="kw-2">&</span><span class="ident">sys</span>::<span class="ident">Event</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">Event</span> { |
| <span class="kw">unsafe</span> { |
| <span class="comment">// This is safe because the memory layout of `Event` is</span> |
| <span class="comment">// the same as `sys::Event` due to the `repr(transparent)` attribute.</span> |
| <span class="kw-2">&</span><span class="kw-2">*</span>(<span class="ident">sys_event</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">sys</span>::<span class="ident">Event</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">Event</span>) |
| } |
| } |
| } |
| |
| <span class="doccomment">/// When the [alternate] flag is enabled this will print platform specific</span> |
| <span class="doccomment">/// details, for example the fields of the `kevent` structure on platforms that</span> |
| <span class="doccomment">/// use `kqueue(2)`. Note however that the output of this implementation is</span> |
| <span class="doccomment">/// **not** consider a part of the stable API.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [alternate]: fmt::Formatter::alternate</span> |
| <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Event</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { |
| <span class="kw">let</span> <span class="ident">alternate</span> <span class="op">=</span> <span class="ident">f</span>.<span class="ident">alternate</span>(); |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"Event"</span>); |
| <span class="ident">d</span>.<span class="ident">field</span>(<span class="string">"token"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">token</span>()) |
| .<span class="ident">field</span>(<span class="string">"readable"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_readable</span>()) |
| .<span class="ident">field</span>(<span class="string">"writable"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_writable</span>()) |
| .<span class="ident">field</span>(<span class="string">"error"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_error</span>()) |
| .<span class="ident">field</span>(<span class="string">"read_closed"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_read_closed</span>()) |
| .<span class="ident">field</span>(<span class="string">"write_closed"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_write_closed</span>()) |
| .<span class="ident">field</span>(<span class="string">"priority"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_priority</span>()) |
| .<span class="ident">field</span>(<span class="string">"aio"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_aio</span>()) |
| .<span class="ident">field</span>(<span class="string">"lio"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">is_lio</span>()); |
| |
| <span class="kw">if</span> <span class="ident">alternate</span> { |
| <span class="kw">struct</span> <span class="ident">EventDetails</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">sys</span>::<span class="ident">Event</span>); |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">EventDetails</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { |
| <span class="ident">sys</span>::<span class="ident">event</span>::<span class="ident">debug_details</span>(<span class="ident">f</span>, <span class="self">self</span>.<span class="number">0</span>) |
| } |
| } |
| |
| <span class="ident">d</span>.<span class="ident">field</span>(<span class="string">"details"</span>, <span class="kw-2">&</span><span class="ident">EventDetails</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>)).<span class="ident">finish</span>() |
| } <span class="kw">else</span> { |
| <span class="ident">d</span>.<span class="ident">finish</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> |