| <!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/source.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>source.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> |
| </pre><div class="example-wrap"><pre class="rust "> |
| <span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">Interest</span>, <span class="ident">Registry</span>, <span class="ident">Token</span>}; |
| |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| |
| <span class="doccomment">/// An event source that may be registered with [`Registry`].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Types that implement `event::Source` can be registered with</span> |
| <span class="doccomment">/// `Registry`. Users of Mio **should not** use the `event::Source` trait</span> |
| <span class="doccomment">/// functions directly. Instead, the equivalent functions on `Registry` should</span> |
| <span class="doccomment">/// be used.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// See [`Registry`] for more details.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`Registry`]: ../struct.Registry.html</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Implementing `event::Source`</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Event sources are always backed by system handles, such as sockets or other</span> |
| <span class="doccomment">/// system handles. These `event::Source`s will be monitored by the system</span> |
| <span class="doccomment">/// selector. An implementation of `Source` will almost always delegates to a</span> |
| <span class="doccomment">/// lower level handle. Examples of this are [`TcpStream`]s, or the *unix only*</span> |
| <span class="doccomment">/// [`SourceFd`].</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`TcpStream`]: ../net/struct.TcpStream.html</span> |
| <span class="doccomment">/// [`SourceFd`]: ../unix/struct.SourceFd.html</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Dropping `event::Source`s</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// All `event::Source`s, unless otherwise specified, need to be [deregistered]</span> |
| <span class="doccomment">/// before being dropped for them to not leak resources. This goes against the</span> |
| <span class="doccomment">/// normal drop behaviour of types in Rust which cleanup after themselves, e.g.</span> |
| <span class="doccomment">/// a `File` will close itself. However since deregistering needs access to</span> |
| <span class="doccomment">/// [`Registry`] this cannot be done while being dropped.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [deregistered]: ../struct.Registry.html#method.deregister</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Examples</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Implementing `Source` on a struct containing a socket:</span> |
| <span class="doccomment">///</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"net"</span>), <span class="ident">doc</span> <span class="op">=</span> <span class="string">"```"</span>)]</span> |
| <span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">not</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"os-poll"</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"net"</span>)), <span class="ident">doc</span> <span class="op">=</span> <span class="string">"```ignore"</span>)]</span> |
| <span class="doccomment">/// use mio::{Interest, Registry, Token};</span> |
| <span class="doccomment">/// use mio::event::Source;</span> |
| <span class="doccomment">/// use mio::net::TcpStream;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// use std::io;</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # #[allow(dead_code)]</span> |
| <span class="doccomment">/// pub struct MySource {</span> |
| <span class="doccomment">/// socket: TcpStream,</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// impl Source for MySource {</span> |
| <span class="doccomment">/// fn register(&mut self, registry: &Registry, token: Token, interests: Interest)</span> |
| <span class="doccomment">/// -> io::Result<()></span> |
| <span class="doccomment">/// {</span> |
| <span class="doccomment">/// // Delegate the `register` call to `socket`</span> |
| <span class="doccomment">/// self.socket.register(registry, token, interests)</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// fn reregister(&mut self, registry: &Registry, token: Token, interests: Interest)</span> |
| <span class="doccomment">/// -> io::Result<()></span> |
| <span class="doccomment">/// {</span> |
| <span class="doccomment">/// // Delegate the `reregister` call to `socket`</span> |
| <span class="doccomment">/// self.socket.reregister(registry, token, interests)</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// fn deregister(&mut self, registry: &Registry) -> io::Result<()> {</span> |
| <span class="doccomment">/// // Delegate the `deregister` call to `socket`</span> |
| <span class="doccomment">/// self.socket.deregister(registry)</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// }</span> |
| <span class="doccomment">/// ```</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Source</span> { |
| <span class="doccomment">/// Register `self` with the given `Registry` instance.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function should not be called directly. Use [`Registry::register`]</span> |
| <span class="doccomment">/// instead. Implementors should handle registration by delegating the call</span> |
| <span class="doccomment">/// to another `Source` type.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`Registry::register`]: ../struct.Registry.html#method.register</span> |
| <span class="kw">fn</span> <span class="ident">register</span>( |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, |
| <span class="ident">registry</span>: <span class="kw-2">&</span><span class="ident">Registry</span>, |
| <span class="ident">token</span>: <span class="ident">Token</span>, |
| <span class="ident">interests</span>: <span class="ident">Interest</span>, |
| ) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>; |
| |
| <span class="doccomment">/// Re-register `self` with the given `Registry` instance.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function should not be called directly. Use</span> |
| <span class="doccomment">/// [`Registry::reregister`] instead. Implementors should handle</span> |
| <span class="doccomment">/// re-registration by either delegating the call to another `Source` type.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`Registry::reregister`]: ../struct.Registry.html#method.reregister</span> |
| <span class="kw">fn</span> <span class="ident">reregister</span>( |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, |
| <span class="ident">registry</span>: <span class="kw-2">&</span><span class="ident">Registry</span>, |
| <span class="ident">token</span>: <span class="ident">Token</span>, |
| <span class="ident">interests</span>: <span class="ident">Interest</span>, |
| ) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>; |
| |
| <span class="doccomment">/// Deregister `self` from the given `Registry` instance.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This function should not be called directly. Use</span> |
| <span class="doccomment">/// [`Registry::deregister`] instead. Implementors should handle</span> |
| <span class="doccomment">/// deregistration by delegating the call to another `Source` type.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// [`Registry::deregister`]: ../struct.Registry.html#method.deregister</span> |
| <span class="kw">fn</span> <span class="ident">deregister</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">registry</span>: <span class="kw-2">&</span><span class="ident">Registry</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>; |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Source</span> <span class="kw">for</span> <span class="ident">Box</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> |
| <span class="kw">where</span> |
| <span class="ident">T</span>: <span class="ident">Source</span> <span class="op">+</span> <span class="question-mark">?</span><span class="ident">Sized</span>, |
| { |
| <span class="kw">fn</span> <span class="ident">register</span>( |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, |
| <span class="ident">registry</span>: <span class="kw-2">&</span><span class="ident">Registry</span>, |
| <span class="ident">token</span>: <span class="ident">Token</span>, |
| <span class="ident">interests</span>: <span class="ident">Interest</span>, |
| ) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| (<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">register</span>(<span class="ident">registry</span>, <span class="ident">token</span>, <span class="ident">interests</span>) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">reregister</span>( |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, |
| <span class="ident">registry</span>: <span class="kw-2">&</span><span class="ident">Registry</span>, |
| <span class="ident">token</span>: <span class="ident">Token</span>, |
| <span class="ident">interests</span>: <span class="ident">Interest</span>, |
| ) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| (<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">reregister</span>(<span class="ident">registry</span>, <span class="ident">token</span>, <span class="ident">interests</span>) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">deregister</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">registry</span>: <span class="kw-2">&</span><span class="ident">Registry</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { |
| (<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">deregister</span>(<span class="ident">registry</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> |
