| <!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tokio-1.28.2/src/io/ready.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ready.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tokio/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| </pre><pre class="rust"><code><span class="attribute">#![cfg_attr(not(feature = <span class="string">"net"</span>), allow(unreachable_pub))] |
| |
| </span><span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::ops; |
| |
| <span class="kw">const </span>READABLE: usize = <span class="number">0b0_01</span>; |
| <span class="kw">const </span>WRITABLE: usize = <span class="number">0b0_10</span>; |
| <span class="kw">const </span>READ_CLOSED: usize = <span class="number">0b0_0100</span>; |
| <span class="kw">const </span>WRITE_CLOSED: usize = <span class="number">0b0_1000</span>; |
| |
| <span class="doccomment">/// Describes the readiness state of an I/O resources. |
| /// |
| /// `Ready` tracks which operation an I/O resource is ready to perform. |
| </span><span class="attribute">#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"net"</span>)))] |
| #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)] |
| </span><span class="kw">pub struct </span>Ready(usize); |
| |
| <span class="kw">impl </span>Ready { |
| <span class="doccomment">/// Returns the empty `Ready` set. |
| </span><span class="kw">pub const </span>EMPTY: Ready = Ready(<span class="number">0</span>); |
| |
| <span class="doccomment">/// Returns a `Ready` representing readable readiness. |
| </span><span class="kw">pub const </span>READABLE: Ready = Ready(READABLE); |
| |
| <span class="doccomment">/// Returns a `Ready` representing writable readiness. |
| </span><span class="kw">pub const </span>WRITABLE: Ready = Ready(WRITABLE); |
| |
| <span class="doccomment">/// Returns a `Ready` representing read closed readiness. |
| </span><span class="kw">pub const </span>READ_CLOSED: Ready = Ready(READ_CLOSED); |
| |
| <span class="doccomment">/// Returns a `Ready` representing write closed readiness. |
| </span><span class="kw">pub const </span>WRITE_CLOSED: Ready = Ready(WRITE_CLOSED); |
| |
| <span class="doccomment">/// Returns a `Ready` representing readiness for all operations. |
| </span><span class="kw">pub const </span>ALL: Ready = Ready(READABLE | WRITABLE | READ_CLOSED | WRITE_CLOSED); |
| |
| <span class="comment">// Must remain crate-private to avoid adding a public dependency on Mio. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_mio(event: <span class="kw-2">&</span>mio::event::Event) -> Ready { |
| <span class="kw">let </span><span class="kw-2">mut </span>ready = Ready::EMPTY; |
| |
| <span class="attribute">#[cfg(all(target_os = <span class="string">"freebsd"</span>, feature = <span class="string">"net"</span>))] |
| </span>{ |
| <span class="kw">if </span>event.is_aio() { |
| ready |= Ready::READABLE; |
| } |
| |
| <span class="kw">if </span>event.is_lio() { |
| ready |= Ready::READABLE; |
| } |
| } |
| |
| <span class="kw">if </span>event.is_readable() { |
| ready |= Ready::READABLE; |
| } |
| |
| <span class="kw">if </span>event.is_writable() { |
| ready |= Ready::WRITABLE; |
| } |
| |
| <span class="kw">if </span>event.is_read_closed() { |
| ready |= Ready::READ_CLOSED; |
| } |
| |
| <span class="kw">if </span>event.is_write_closed() { |
| ready |= Ready::WRITE_CLOSED; |
| } |
| |
| ready |
| } |
| |
| <span class="doccomment">/// Returns true if `Ready` is the empty set. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::io::Ready; |
| /// |
| /// assert!(Ready::EMPTY.is_empty()); |
| /// assert!(!Ready::READABLE.is_empty()); |
| /// ``` |
| </span><span class="kw">pub fn </span>is_empty(<span class="self">self</span>) -> bool { |
| <span class="self">self </span>== Ready::EMPTY |
| } |
| |
| <span class="doccomment">/// Returns `true` if the value includes `readable`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::io::Ready; |
| /// |
| /// assert!(!Ready::EMPTY.is_readable()); |
| /// assert!(Ready::READABLE.is_readable()); |
| /// assert!(Ready::READ_CLOSED.is_readable()); |
| /// assert!(!Ready::WRITABLE.is_readable()); |
| /// ``` |
| </span><span class="kw">pub fn </span>is_readable(<span class="self">self</span>) -> bool { |
| <span class="self">self</span>.contains(Ready::READABLE) || <span class="self">self</span>.is_read_closed() |
| } |
| |
| <span class="doccomment">/// Returns `true` if the value includes writable `readiness`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::io::Ready; |
| /// |
| /// assert!(!Ready::EMPTY.is_writable()); |
| /// assert!(!Ready::READABLE.is_writable()); |
| /// assert!(Ready::WRITABLE.is_writable()); |
| /// assert!(Ready::WRITE_CLOSED.is_writable()); |
| /// ``` |
| </span><span class="kw">pub fn </span>is_writable(<span class="self">self</span>) -> bool { |
| <span class="self">self</span>.contains(Ready::WRITABLE) || <span class="self">self</span>.is_write_closed() |
| } |
| |
| <span class="doccomment">/// Returns `true` if the value includes read-closed `readiness`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::io::Ready; |
| /// |
| /// assert!(!Ready::EMPTY.is_read_closed()); |
| /// assert!(!Ready::READABLE.is_read_closed()); |
| /// assert!(Ready::READ_CLOSED.is_read_closed()); |
| /// ``` |
| </span><span class="kw">pub fn </span>is_read_closed(<span class="self">self</span>) -> bool { |
| <span class="self">self</span>.contains(Ready::READ_CLOSED) |
| } |
| |
| <span class="doccomment">/// Returns `true` if the value includes write-closed `readiness`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio::io::Ready; |
| /// |
| /// assert!(!Ready::EMPTY.is_write_closed()); |
| /// assert!(!Ready::WRITABLE.is_write_closed()); |
| /// assert!(Ready::WRITE_CLOSED.is_write_closed()); |
| /// ``` |
| </span><span class="kw">pub fn </span>is_write_closed(<span class="self">self</span>) -> bool { |
| <span class="self">self</span>.contains(Ready::WRITE_CLOSED) |
| } |
| |
| <span class="doccomment">/// Returns true if `self` is a superset of `other`. |
| /// |
| /// `other` may represent more than one readiness operations, in which case |
| /// the function only returns true if `self` contains all readiness |
| /// specified in `other`. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>contains<T: Into<<span class="self">Self</span>>>(<span class="self">self</span>, other: T) -> bool { |
| <span class="kw">let </span>other = other.into(); |
| (<span class="self">self </span>& other) == other |
| } |
| |
| <span class="doccomment">/// Creates a `Ready` instance using the given `usize` representation. |
| /// |
| /// The `usize` representation must have been obtained from a call to |
| /// `Readiness::as_usize`. |
| /// |
| /// This function is mainly provided to allow the caller to get a |
| /// readiness value from an `AtomicUsize`. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_usize(val: usize) -> Ready { |
| Ready(val & Ready::ALL.as_usize()) |
| } |
| |
| <span class="doccomment">/// Returns a `usize` representation of the `Ready` value. |
| /// |
| /// This function is mainly provided to allow the caller to store a |
| /// readiness value in an `AtomicUsize`. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_usize(<span class="self">self</span>) -> usize { |
| <span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="macro">cfg_io_readiness! </span>{ |
| <span class="kw">use </span><span class="kw">crate</span>::io::Interest; |
| |
| <span class="kw">impl </span>Ready { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_interest(interest: Interest) -> Ready { |
| <span class="kw">let </span><span class="kw-2">mut </span>ready = Ready::EMPTY; |
| |
| <span class="kw">if </span>interest.is_readable() { |
| ready |= Ready::READABLE; |
| ready |= Ready::READ_CLOSED; |
| } |
| |
| <span class="kw">if </span>interest.is_writable() { |
| ready |= Ready::WRITABLE; |
| ready |= Ready::WRITE_CLOSED; |
| } |
| |
| ready |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>intersection(<span class="self">self</span>, interest: Interest) -> Ready { |
| Ready(<span class="self">self</span>.<span class="number">0 </span>& Ready::from_interest(interest).<span class="number">0</span>) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>satisfies(<span class="self">self</span>, interest: Interest) -> bool { |
| <span class="self">self</span>.<span class="number">0 </span>& Ready::from_interest(interest).<span class="number">0 </span>!= <span class="number">0 |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl </span>ops::BitOr<Ready> <span class="kw">for </span>Ready { |
| <span class="kw">type </span>Output = Ready; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>bitor(<span class="self">self</span>, other: Ready) -> Ready { |
| Ready(<span class="self">self</span>.<span class="number">0 </span>| other.<span class="number">0</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>ops::BitOrAssign<Ready> <span class="kw">for </span>Ready { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>bitor_assign(<span class="kw-2">&mut </span><span class="self">self</span>, other: Ready) { |
| <span class="self">self</span>.<span class="number">0 </span>|= other.<span class="number">0</span>; |
| } |
| } |
| |
| <span class="kw">impl </span>ops::BitAnd<Ready> <span class="kw">for </span>Ready { |
| <span class="kw">type </span>Output = Ready; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>bitand(<span class="self">self</span>, other: Ready) -> Ready { |
| Ready(<span class="self">self</span>.<span class="number">0 </span>& other.<span class="number">0</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>ops::Sub<Ready> <span class="kw">for </span>Ready { |
| <span class="kw">type </span>Output = Ready; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>sub(<span class="self">self</span>, other: Ready) -> Ready { |
| Ready(<span class="self">self</span>.<span class="number">0 </span>& !other.<span class="number">0</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Ready { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| fmt.debug_struct(<span class="string">"Ready"</span>) |
| .field(<span class="string">"is_readable"</span>, <span class="kw-2">&</span><span class="self">self</span>.is_readable()) |
| .field(<span class="string">"is_writable"</span>, <span class="kw-2">&</span><span class="self">self</span>.is_writable()) |
| .field(<span class="string">"is_read_closed"</span>, <span class="kw-2">&</span><span class="self">self</span>.is_read_closed()) |
| .field(<span class="string">"is_write_closed"</span>, <span class="kw-2">&</span><span class="self">self</span>.is_write_closed()) |
| .finish() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
