| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/mio/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../mio/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="../../mio/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> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| </pre><pre class="rust"><code><span class="attribute">#![deny( |
| missing_docs, |
| missing_debug_implementations, |
| rust_2018_idioms, |
| unused_imports, |
| dead_code |
| )] |
| #![cfg_attr(docsrs, feature(doc_cfg))] |
| </span><span class="comment">// Disallow warnings when running tests. |
| </span><span class="attribute">#![cfg_attr(test, deny(warnings))] |
| </span><span class="comment">// Disallow warnings in examples. |
| </span><span class="attribute">#![doc(test(attr(deny(warnings))))] |
| |
| </span><span class="doccomment">//! Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs |
| //! and event notification for building high performance I/O apps with as little |
| //! overhead as possible over the OS abstractions. |
| //! |
| //! # Usage |
| //! |
| //! Using Mio starts by creating a [`Poll`], which reads events from the OS and |
| //! puts them into [`Events`]. You can handle I/O events from the OS with it. |
| //! |
| //! For more detail, see [`Poll`]. |
| //! |
| //! [`Poll`]: ../mio/struct.Poll.html |
| //! [`Events`]: ../mio/event/struct.Events.html |
| //! |
| //! ## Examples |
| //! |
| //! Examples can found in the `examples` directory of the source code, or [on |
| //! GitHub]. |
| //! |
| //! [on GitHub]: https://github.com/tokio-rs/mio/tree/master/examples |
| //! |
| //! ## Guide |
| //! |
| //! A getting started guide is available in the [`guide`] module. |
| //! |
| //! ## Available features |
| //! |
| //! The available features are described in the [`features`] module. |
| |
| </span><span class="comment">// macros used internally |
| </span><span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>macros; |
| |
| <span class="kw">mod </span>interest; |
| <span class="kw">mod </span>poll; |
| <span class="kw">mod </span>sys; |
| <span class="kw">mod </span>token; |
| <span class="attribute">#[cfg(not(target_os = <span class="string">"wasi"</span>))] |
| </span><span class="kw">mod </span>waker; |
| |
| <span class="kw">pub mod </span>event; |
| |
| <span class="macro">cfg_io_source! </span>{ |
| <span class="kw">mod </span>io_source; |
| } |
| |
| <span class="macro">cfg_net! </span>{ |
| <span class="kw">pub mod </span>net; |
| } |
| |
| <span class="attribute">#[doc(no_inline)] |
| </span><span class="kw">pub use </span>event::Events; |
| <span class="kw">pub use </span>interest::Interest; |
| <span class="kw">pub use </span>poll::{Poll, Registry}; |
| <span class="kw">pub use </span>token::Token; |
| <span class="attribute">#[cfg(not(target_os = <span class="string">"wasi"</span>))] |
| </span><span class="kw">pub use </span>waker::Waker; |
| |
| <span class="attribute">#[cfg(all(unix, feature = <span class="string">"os-ext"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(all(unix, feature = <span class="string">"os-ext"</span>))))] |
| </span><span class="kw">pub mod </span>unix { |
| <span class="doccomment">//! Unix only extensions. |
| </span><span class="attribute">#[cfg(not(target_vendor = <span class="string">"teaclave"</span>))] |
| </span><span class="kw">pub mod </span>pipe { |
| <span class="doccomment">//! Unix pipe. |
| //! |
| //! See the [`new`] function for documentation. |
| |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::pipe::{new, Receiver, Sender}; |
| } |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::sys::SourceFd; |
| } |
| |
| <span class="attribute">#[cfg(all(windows, feature = <span class="string">"os-ext"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(all(windows, feature = <span class="string">"os-ext"</span>))))] |
| </span><span class="kw">pub mod </span>windows { |
| <span class="doccomment">//! Windows only extensions. |
| |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::named_pipe::NamedPipe; |
| } |
| |
| <span class="kw">pub mod </span>features { |
| <span class="doccomment">//! # Mio's optional features. |
| //! |
| //! This document describes the available features in Mio. |
| //! |
| </span><span class="attribute">#![cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"## `os-poll` (enabled)"</span>)] |
| #![cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"## `os-poll` (disabled)"</span>)] |
| </span><span class="doccomment">//! |
| //! Mio by default provides only a shell implementation that `panic!`s the |
| //! moment it is actually run. To run it requires OS support, this is |
| //! enabled by activating the `os-poll` feature. |
| //! |
| //! This makes `Poll`, `Registry` and `Waker` functional. |
| //! |
| </span><span class="attribute">#![cfg_attr(feature = <span class="string">"os-ext"</span>, doc = <span class="string">"## `os-ext` (enabled)"</span>)] |
| #![cfg_attr(not(feature = <span class="string">"os-ext"</span>), doc = <span class="string">"## `os-ext` (disabled)"</span>)] |
| </span><span class="doccomment">//! |
| //! `os-ext` enables additional OS specific facilities. These facilities can |
| //! be found in the `unix` and `windows` module. |
| //! |
| </span><span class="attribute">#![cfg_attr(feature = <span class="string">"net"</span>, doc = <span class="string">"## Network types (enabled)"</span>)] |
| #![cfg_attr(not(feature = <span class="string">"net"</span>), doc = <span class="string">"## Network types (disabled)"</span>)] |
| </span><span class="doccomment">//! |
| //! The `net` feature enables networking primitives in the `net` module. |
| </span>} |
| |
| <span class="kw">pub mod </span>guide { |
| <span class="doccomment">//! # Getting started guide. |
| //! |
| //! In this guide we'll do the following: |
| //! |
| //! 1. Create a [`Poll`] instance (and learn what it is). |
| //! 2. Register an [event source]. |
| //! 3. Create an event loop. |
| //! |
| //! At the end you'll have a very small (but quick) TCP server that accepts |
| //! connections and then drops (disconnects) them. |
| //! |
| //! ## 1. Creating a `Poll` instance |
| //! |
| //! Using Mio starts by creating a [`Poll`] instance, which monitors events |
| //! from the OS and puts them into [`Events`]. This allows us to execute I/O |
| //! operations based on what operations are ready. |
| //! |
| //! [`Poll`]: ../struct.Poll.html |
| //! [`Events`]: ../event/struct.Events.html |
| //! |
| </span><span class="attribute">#![cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #![cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">//! # use mio::{Poll, Events}; |
| //! # fn main() -> std::io::Result<()> { |
| //! // `Poll` allows for polling of readiness events. |
| //! let poll = Poll::new()?; |
| //! // `Events` is collection of readiness `Event`s and can be filled by |
| //! // calling `Poll::poll`. |
| //! let events = Events::with_capacity(128); |
| //! # drop((poll, events)); |
| //! # Ok(()) |
| //! # } |
| //! ``` |
| //! |
| //! For example if we're using a [`TcpListener`], we'll only want to |
| //! attempt to accept an incoming connection *iff* any connections are |
| //! queued and ready to be accepted. We don't want to waste our time if no |
| //! connections are ready. |
| //! |
| //! [`TcpListener`]: ../net/struct.TcpListener.html |
| //! |
| //! ## 2. Registering event source |
| //! |
| //! After we've created a [`Poll`] instance that monitors events from the OS |
| //! for us, we need to provide it with a source of events. This is done by |
| //! registering an [event source]. As the name “event source” suggests it is |
| //! a source of events which can be polled using a `Poll` instance. On Unix |
| //! systems this is usually a file descriptor, or a socket/handle on |
| //! Windows. |
| //! |
| //! In the example below we'll use a [`TcpListener`] for which we'll receive |
| //! an event (from [`Poll`]) once a connection is ready to be accepted. |
| //! |
| //! [event source]: ../event/trait.Source.html |
| //! |
| </span><span class="attribute">#![cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)] |
| #![cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">//! # use mio::net::TcpListener; |
| //! # use mio::{Poll, Token, Interest}; |
| //! # fn main() -> std::io::Result<()> { |
| //! # let poll = Poll::new()?; |
| //! # let address = "127.0.0.1:0".parse().unwrap(); |
| //! // Create a `TcpListener`, binding it to `address`. |
| //! let mut listener = TcpListener::bind(address)?; |
| //! |
| //! // Next we register it with `Poll` to receive events for it. The `SERVER` |
| //! // `Token` is used to determine that we received an event for the listener |
| //! // later on. |
| //! const SERVER: Token = Token(0); |
| //! poll.registry().register(&mut listener, SERVER, Interest::READABLE)?; |
| //! # Ok(()) |
| //! # } |
| //! ``` |
| //! |
| //! Multiple event sources can be [registered] (concurrently), so we can |
| //! monitor multiple sources at a time. |
| //! |
| //! [registered]: ../struct.Registry.html#method.register |
| //! |
| //! ## 3. Creating the event loop |
| //! |
| //! After we've created a [`Poll`] instance and registered one or more |
| //! [event sources] with it, we can [poll] it for events. Polling for events |
| //! is simple, we need a container to store the events: [`Events`] and need |
| //! to do something based on the polled events (this part is up to you, we |
| //! can't do it all!). If we do this in a loop we've got ourselves an event |
| //! loop. |
| //! |
| //! The example below shows the event loop in action, completing our small |
| //! TCP server. |
| //! |
| //! [poll]: ../struct.Poll.html#method.poll |
| //! [event sources]: ../event/trait.Source.html |
| //! |
| </span><span class="attribute">#![cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)] |
| #![cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">//! # use std::io; |
| //! # use std::time::Duration; |
| //! # use mio::net::TcpListener; |
| //! # use mio::{Poll, Token, Interest, Events}; |
| //! # fn main() -> io::Result<()> { |
| //! # let mut poll = Poll::new()?; |
| //! # let mut events = Events::with_capacity(128); |
| //! # let address = "127.0.0.1:0".parse().unwrap(); |
| //! # let mut listener = TcpListener::bind(address)?; |
| //! # const SERVER: Token = Token(0); |
| //! # poll.registry().register(&mut listener, SERVER, Interest::READABLE)?; |
| //! // Start our event loop. |
| //! loop { |
| //! // Poll the OS for events, waiting at most 100 milliseconds. |
| //! poll.poll(&mut events, Some(Duration::from_millis(100)))?; |
| //! |
| //! // Process each event. |
| //! for event in events.iter() { |
| //! // We can use the token we previously provided to `register` to |
| //! // determine for which type the event is. |
| //! match event.token() { |
| //! SERVER => loop { |
| //! // One or more connections are ready, so we'll attempt to |
| //! // accept them (in a loop). |
| //! match listener.accept() { |
| //! Ok((connection, address)) => { |
| //! println!("Got a connection from: {}", address); |
| //! # drop(connection); |
| //! }, |
| //! // A "would block error" is returned if the operation |
| //! // is not ready, so we'll stop trying to accept |
| //! // connections. |
| //! Err(ref err) if would_block(err) => break, |
| //! Err(err) => return Err(err), |
| //! } |
| //! } |
| //! # _ => unreachable!(), |
| //! } |
| //! } |
| //! # return Ok(()); |
| //! } |
| //! |
| //! fn would_block(err: &io::Error) -> bool { |
| //! err.kind() == io::ErrorKind::WouldBlock |
| //! } |
| //! # } |
| //! ``` |
| </span>} |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="mio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
