Adding large folders

This commit is contained in:
2026-02-26 12:00:21 -05:00
parent 5400d82acd
commit 49701c85ad
47332 changed files with 1942573 additions and 0 deletions
+231
View File
@@ -0,0 +1,231 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/event/event.rs`."><title>event.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/event/</div>event.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{sys, Token};
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::fmt;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="doccomment">/// A readiness event.
<a href=#6 id=6 data-nosnippet>6</a>///
<a href=#7 id=7 data-nosnippet>7</a>/// `Event` is a readiness state paired with a [`Token`]. It is returned by
<a href=#8 id=8 data-nosnippet>8</a>/// [`Poll::poll`].
<a href=#9 id=9 data-nosnippet>9</a>///
<a href=#10 id=10 data-nosnippet>10</a>/// For more documentation on polling and events, see [`Poll`].
<a href=#11 id=11 data-nosnippet>11</a>///
<a href=#12 id=12 data-nosnippet>12</a>/// [`Poll::poll`]: ../struct.Poll.html#method.poll
<a href=#13 id=13 data-nosnippet>13</a>/// [`Poll`]: ../struct.Poll.html
<a href=#14 id=14 data-nosnippet>14</a>/// [`Token`]: ../struct.Token.html
<a href=#15 id=15 data-nosnippet>15</a></span><span class="attr">#[derive(Clone)]
<a href=#16 id=16 data-nosnippet>16</a>#[repr(transparent)]
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">pub struct </span>Event {
<a href=#18 id=18 data-nosnippet>18</a> inner: sys::Event,
<a href=#19 id=19 data-nosnippet>19</a>}
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">impl </span>Event {
<a href=#22 id=22 data-nosnippet>22</a> <span class="doccomment">/// Returns the event's token.
<a href=#23 id=23 data-nosnippet>23</a> </span><span class="kw">pub fn </span>token(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Token {
<a href=#24 id=24 data-nosnippet>24</a> sys::event::token(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#25 id=25 data-nosnippet>25</a> }
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a> <span class="doccomment">/// Returns true if the event contains readable readiness.
<a href=#28 id=28 data-nosnippet>28</a> ///
<a href=#29 id=29 data-nosnippet>29</a> /// # Notes
<a href=#30 id=30 data-nosnippet>30</a> ///
<a href=#31 id=31 data-nosnippet>31</a> /// Out-of-band (OOB) data also triggers readable events. But most
<a href=#32 id=32 data-nosnippet>32</a> /// applications don't actually read OOB data, this could leave an
<a href=#33 id=33 data-nosnippet>33</a> /// application open to a Denial-of-Service (Dos) attack, see
<a href=#34 id=34 data-nosnippet>34</a> /// &lt;https://github.com/sandstorm-io/sandstorm-website/blob/58f93346028c0576e8147627667328eaaf4be9fa/_posts/2015-04-08-osx-security-bug.md&gt;.
<a href=#35 id=35 data-nosnippet>35</a> /// However because Mio uses edge-triggers it will not result in an infinite
<a href=#36 id=36 data-nosnippet>36</a> /// loop as described in the article above.
<a href=#37 id=37 data-nosnippet>37</a> </span><span class="kw">pub fn </span>is_readable(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#38 id=38 data-nosnippet>38</a> sys::event::is_readable(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="doccomment">/// Returns true if the event contains writable readiness.
<a href=#42 id=42 data-nosnippet>42</a> </span><span class="kw">pub fn </span>is_writable(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#43 id=43 data-nosnippet>43</a> sys::event::is_writable(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="doccomment">/// Returns true if the event contains error readiness.
<a href=#47 id=47 data-nosnippet>47</a> ///
<a href=#48 id=48 data-nosnippet>48</a> /// Error events occur when the socket enters an error state. In this case,
<a href=#49 id=49 data-nosnippet>49</a> /// the socket will also receive a readable or writable event. Reading or
<a href=#50 id=50 data-nosnippet>50</a> /// writing to the socket will result in an error.
<a href=#51 id=51 data-nosnippet>51</a> ///
<a href=#52 id=52 data-nosnippet>52</a> /// # Notes
<a href=#53 id=53 data-nosnippet>53</a> ///
<a href=#54 id=54 data-nosnippet>54</a> /// Method is available on all platforms, but not all platforms trigger the
<a href=#55 id=55 data-nosnippet>55</a> /// error event.
<a href=#56 id=56 data-nosnippet>56</a> ///
<a href=#57 id=57 data-nosnippet>57</a> /// The table below shows what flags are checked on what OS.
<a href=#58 id=58 data-nosnippet>58</a> ///
<a href=#59 id=59 data-nosnippet>59</a> /// | [OS selector] | Flag(s) checked |
<a href=#60 id=60 data-nosnippet>60</a> /// |---------------|-----------------|
<a href=#61 id=61 data-nosnippet>61</a> /// | [epoll] | `EPOLLERR` |
<a href=#62 id=62 data-nosnippet>62</a> /// | [kqueue] | `EV_ERROR` and `EV_EOF` with `fflags` set to `0`. |
<a href=#63 id=63 data-nosnippet>63</a> ///
<a href=#64 id=64 data-nosnippet>64</a> /// [OS selector]: ../struct.Poll.html#implementation-notes
<a href=#65 id=65 data-nosnippet>65</a> /// [epoll]: https://man7.org/linux/man-pages/man7/epoll.7.html
<a href=#66 id=66 data-nosnippet>66</a> /// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&amp;sektion=2
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="kw">pub fn </span>is_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#68 id=68 data-nosnippet>68</a> sys::event::is_error(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#69 id=69 data-nosnippet>69</a> }
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> <span class="doccomment">/// Returns true if the event contains read closed readiness.
<a href=#72 id=72 data-nosnippet>72</a> ///
<a href=#73 id=73 data-nosnippet>73</a> /// # Notes
<a href=#74 id=74 data-nosnippet>74</a> ///
<a href=#75 id=75 data-nosnippet>75</a> /// Read closed readiness can be expected after any of the following have
<a href=#76 id=76 data-nosnippet>76</a> /// occurred:
<a href=#77 id=77 data-nosnippet>77</a> /// * The local stream has shutdown the read half of its socket
<a href=#78 id=78 data-nosnippet>78</a> /// * The local stream has shutdown both the read half and the write half
<a href=#79 id=79 data-nosnippet>79</a> /// of its socket
<a href=#80 id=80 data-nosnippet>80</a> /// * The peer stream has shutdown the write half its socket; this sends a
<a href=#81 id=81 data-nosnippet>81</a> /// `FIN` packet that has been received by the local stream
<a href=#82 id=82 data-nosnippet>82</a> ///
<a href=#83 id=83 data-nosnippet>83</a> /// Method is a best effort implementation. While some platforms may not
<a href=#84 id=84 data-nosnippet>84</a> /// return readiness when read half is closed, it is guaranteed that
<a href=#85 id=85 data-nosnippet>85</a> /// false-positives will not occur.
<a href=#86 id=86 data-nosnippet>86</a> ///
<a href=#87 id=87 data-nosnippet>87</a> /// The table below shows what flags are checked on what OS.
<a href=#88 id=88 data-nosnippet>88</a> ///
<a href=#89 id=89 data-nosnippet>89</a> /// | [OS selector] | Flag(s) checked |
<a href=#90 id=90 data-nosnippet>90</a> /// |---------------|-----------------|
<a href=#91 id=91 data-nosnippet>91</a> /// | [epoll] | `EPOLLHUP`, or |
<a href=#92 id=92 data-nosnippet>92</a> /// | | `EPOLLIN` and `EPOLLRDHUP` |
<a href=#93 id=93 data-nosnippet>93</a> /// | [kqueue] | `EV_EOF` |
<a href=#94 id=94 data-nosnippet>94</a> ///
<a href=#95 id=95 data-nosnippet>95</a> /// [OS selector]: ../struct.Poll.html#implementation-notes
<a href=#96 id=96 data-nosnippet>96</a> /// [epoll]: https://man7.org/linux/man-pages/man7/epoll.7.html
<a href=#97 id=97 data-nosnippet>97</a> /// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&amp;sektion=2
<a href=#98 id=98 data-nosnippet>98</a> </span><span class="kw">pub fn </span>is_read_closed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#99 id=99 data-nosnippet>99</a> sys::event::is_read_closed(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#100 id=100 data-nosnippet>100</a> }
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a> <span class="doccomment">/// Returns true if the event contains write closed readiness.
<a href=#103 id=103 data-nosnippet>103</a> ///
<a href=#104 id=104 data-nosnippet>104</a> /// # Notes
<a href=#105 id=105 data-nosnippet>105</a> ///
<a href=#106 id=106 data-nosnippet>106</a> /// On [epoll] this is essentially a check for `EPOLLHUP` flag as the
<a href=#107 id=107 data-nosnippet>107</a> /// local stream shutting down its write half does not trigger this event.
<a href=#108 id=108 data-nosnippet>108</a> ///
<a href=#109 id=109 data-nosnippet>109</a> /// On [kqueue] the local stream shutting down the write half of its
<a href=#110 id=110 data-nosnippet>110</a> /// socket will trigger this event.
<a href=#111 id=111 data-nosnippet>111</a> ///
<a href=#112 id=112 data-nosnippet>112</a> /// Method is a best effort implementation. While some platforms may not
<a href=#113 id=113 data-nosnippet>113</a> /// return readiness when write half is closed, it is guaranteed that
<a href=#114 id=114 data-nosnippet>114</a> /// false-positives will not occur.
<a href=#115 id=115 data-nosnippet>115</a> ///
<a href=#116 id=116 data-nosnippet>116</a> /// The table below shows what flags are checked on what OS.
<a href=#117 id=117 data-nosnippet>117</a> ///
<a href=#118 id=118 data-nosnippet>118</a> /// | [OS selector] | Flag(s) checked |
<a href=#119 id=119 data-nosnippet>119</a> /// |---------------|-----------------|
<a href=#120 id=120 data-nosnippet>120</a> /// | [epoll] | `EPOLLHUP`, or |
<a href=#121 id=121 data-nosnippet>121</a> /// | | only `EPOLLERR`, or |
<a href=#122 id=122 data-nosnippet>122</a> /// | | `EPOLLOUT` and `EPOLLERR` |
<a href=#123 id=123 data-nosnippet>123</a> /// | [kqueue] | `EV_EOF` |
<a href=#124 id=124 data-nosnippet>124</a> ///
<a href=#125 id=125 data-nosnippet>125</a> /// [OS selector]: ../struct.Poll.html#implementation-notes
<a href=#126 id=126 data-nosnippet>126</a> /// [epoll]: https://man7.org/linux/man-pages/man7/epoll.7.html
<a href=#127 id=127 data-nosnippet>127</a> /// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&amp;sektion=2
<a href=#128 id=128 data-nosnippet>128</a> </span><span class="kw">pub fn </span>is_write_closed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#129 id=129 data-nosnippet>129</a> sys::event::is_write_closed(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#130 id=130 data-nosnippet>130</a> }
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a> <span class="doccomment">/// Returns true if the event contains priority readiness.
<a href=#133 id=133 data-nosnippet>133</a> ///
<a href=#134 id=134 data-nosnippet>134</a> /// # Notes
<a href=#135 id=135 data-nosnippet>135</a> ///
<a href=#136 id=136 data-nosnippet>136</a> /// Method is available on all platforms, but not all platforms trigger the
<a href=#137 id=137 data-nosnippet>137</a> /// priority event.
<a href=#138 id=138 data-nosnippet>138</a> ///
<a href=#139 id=139 data-nosnippet>139</a> /// The table below shows what flags are checked on what OS.
<a href=#140 id=140 data-nosnippet>140</a> ///
<a href=#141 id=141 data-nosnippet>141</a> /// | [OS selector] | Flag(s) checked |
<a href=#142 id=142 data-nosnippet>142</a> /// |---------------|-----------------|
<a href=#143 id=143 data-nosnippet>143</a> /// | [epoll] | `EPOLLPRI` |
<a href=#144 id=144 data-nosnippet>144</a> /// | [kqueue] | *Not supported* |
<a href=#145 id=145 data-nosnippet>145</a> ///
<a href=#146 id=146 data-nosnippet>146</a> /// [OS selector]: ../struct.Poll.html#implementation-notes
<a href=#147 id=147 data-nosnippet>147</a> /// [epoll]: https://man7.org/linux/man-pages/man7/epoll.7.html
<a href=#148 id=148 data-nosnippet>148</a> /// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&amp;sektion=2
<a href=#149 id=149 data-nosnippet>149</a> </span><span class="attr">#[inline]
<a href=#150 id=150 data-nosnippet>150</a> </span><span class="kw">pub fn </span>is_priority(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#151 id=151 data-nosnippet>151</a> sys::event::is_priority(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#152 id=152 data-nosnippet>152</a> }
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a> <span class="doccomment">/// Returns true if the event contains AIO readiness.
<a href=#155 id=155 data-nosnippet>155</a> ///
<a href=#156 id=156 data-nosnippet>156</a> /// # Notes
<a href=#157 id=157 data-nosnippet>157</a> ///
<a href=#158 id=158 data-nosnippet>158</a> /// Method is available on all platforms, but not all platforms support AIO.
<a href=#159 id=159 data-nosnippet>159</a> ///
<a href=#160 id=160 data-nosnippet>160</a> /// The table below shows what flags are checked on what OS.
<a href=#161 id=161 data-nosnippet>161</a> ///
<a href=#162 id=162 data-nosnippet>162</a> /// | [OS selector] | Flag(s) checked |
<a href=#163 id=163 data-nosnippet>163</a> /// |---------------|-----------------|
<a href=#164 id=164 data-nosnippet>164</a> /// | [epoll] | *Not supported* |
<a href=#165 id=165 data-nosnippet>165</a> /// | [kqueue]&lt;sup&gt;1&lt;/sup&gt; | `EVFILT_AIO` |
<a href=#166 id=166 data-nosnippet>166</a> ///
<a href=#167 id=167 data-nosnippet>167</a> /// 1: Only supported on DragonFly BSD, FreeBSD, iOS and macOS.
<a href=#168 id=168 data-nosnippet>168</a> ///
<a href=#169 id=169 data-nosnippet>169</a> /// [OS selector]: ../struct.Poll.html#implementation-notes
<a href=#170 id=170 data-nosnippet>170</a> /// [epoll]: https://man7.org/linux/man-pages/man7/epoll.7.html
<a href=#171 id=171 data-nosnippet>171</a> /// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&amp;sektion=2
<a href=#172 id=172 data-nosnippet>172</a> </span><span class="kw">pub fn </span>is_aio(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#173 id=173 data-nosnippet>173</a> sys::event::is_aio(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#174 id=174 data-nosnippet>174</a> }
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> <span class="doccomment">/// Returns true if the event contains LIO readiness.
<a href=#177 id=177 data-nosnippet>177</a> ///
<a href=#178 id=178 data-nosnippet>178</a> /// # Notes
<a href=#179 id=179 data-nosnippet>179</a> ///
<a href=#180 id=180 data-nosnippet>180</a> /// Method is available on all platforms, but only FreeBSD supports LIO. On
<a href=#181 id=181 data-nosnippet>181</a> /// FreeBSD this method checks the `EVFILT_LIO` flag.
<a href=#182 id=182 data-nosnippet>182</a> </span><span class="kw">pub fn </span>is_lio(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#183 id=183 data-nosnippet>183</a> sys::event::is_lio(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#184 id=184 data-nosnippet>184</a> }
<a href=#185 id=185 data-nosnippet>185</a>
<a href=#186 id=186 data-nosnippet>186</a> <span class="doccomment">/// Create a reference to an `Event` from a platform specific event.
<a href=#187 id=187 data-nosnippet>187</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_sys_event_ref(sys_event: <span class="kw-2">&amp;</span>sys::Event) -&gt; <span class="kw-2">&amp;</span>Event {
<a href=#188 id=188 data-nosnippet>188</a> <span class="kw">unsafe </span>{
<a href=#189 id=189 data-nosnippet>189</a> <span class="comment">// This is safe because the memory layout of `Event` is
<a href=#190 id=190 data-nosnippet>190</a> // the same as `sys::Event` due to the `repr(transparent)` attribute.
<a href=#191 id=191 data-nosnippet>191</a> </span><span class="kw-2">&amp;*</span>(sys_event <span class="kw">as </span><span class="kw-2">*const </span>sys::Event <span class="kw">as </span><span class="kw-2">*const </span>Event)
<a href=#192 id=192 data-nosnippet>192</a> }
<a href=#193 id=193 data-nosnippet>193</a> }
<a href=#194 id=194 data-nosnippet>194</a>}
<a href=#195 id=195 data-nosnippet>195</a>
<a href=#196 id=196 data-nosnippet>196</a><span class="doccomment">/// When the [alternate] flag is enabled this will print platform specific
<a href=#197 id=197 data-nosnippet>197</a>/// details, for example the fields of the `kevent` structure on platforms that
<a href=#198 id=198 data-nosnippet>198</a>/// use `kqueue(2)`. Note however that the output of this implementation is
<a href=#199 id=199 data-nosnippet>199</a>/// **not** consider a part of the stable API.
<a href=#200 id=200 data-nosnippet>200</a>///
<a href=#201 id=201 data-nosnippet>201</a>/// [alternate]: fmt::Formatter::alternate
<a href=#202 id=202 data-nosnippet>202</a></span><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Event {
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#204 id=204 data-nosnippet>204</a> <span class="kw">let </span>alternate = f.alternate();
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">let </span><span class="kw-2">mut </span>d = f.debug_struct(<span class="string">"Event"</span>);
<a href=#206 id=206 data-nosnippet>206</a> d.field(<span class="string">"token"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.token())
<a href=#207 id=207 data-nosnippet>207</a> .field(<span class="string">"readable"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_readable())
<a href=#208 id=208 data-nosnippet>208</a> .field(<span class="string">"writable"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_writable())
<a href=#209 id=209 data-nosnippet>209</a> .field(<span class="string">"error"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_error())
<a href=#210 id=210 data-nosnippet>210</a> .field(<span class="string">"read_closed"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_read_closed())
<a href=#211 id=211 data-nosnippet>211</a> .field(<span class="string">"write_closed"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_write_closed())
<a href=#212 id=212 data-nosnippet>212</a> .field(<span class="string">"priority"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_priority())
<a href=#213 id=213 data-nosnippet>213</a> .field(<span class="string">"aio"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_aio())
<a href=#214 id=214 data-nosnippet>214</a> .field(<span class="string">"lio"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.is_lio());
<a href=#215 id=215 data-nosnippet>215</a>
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">if </span>alternate {
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">struct </span>EventDetails&lt;<span class="lifetime">'a</span>&gt;(<span class="kw-2">&amp;</span><span class="lifetime">'a </span>sys::Event);
<a href=#218 id=218 data-nosnippet>218</a>
<a href=#219 id=219 data-nosnippet>219</a> <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>EventDetails&lt;<span class="lifetime">'_</span>&gt; {
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#221 id=221 data-nosnippet>221</a> sys::event::debug_details(f, <span class="self">self</span>.<span class="number">0</span>)
<a href=#222 id=222 data-nosnippet>222</a> }
<a href=#223 id=223 data-nosnippet>223</a> }
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a> d.field(<span class="string">"details"</span>, <span class="kw-2">&amp;</span>EventDetails(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)).finish()
<a href=#226 id=226 data-nosnippet>226</a> } <span class="kw">else </span>{
<a href=#227 id=227 data-nosnippet>227</a> d.finish()
<a href=#228 id=228 data-nosnippet>228</a> }
<a href=#229 id=229 data-nosnippet>229</a> }
<a href=#230 id=230 data-nosnippet>230</a>}
</code></pre></div></section></main></body></html>
+231
View File
@@ -0,0 +1,231 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/event/events.rs`."><title>events.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/event/</div>events.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span><span class="kw">crate</span>::event::Event;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span><span class="kw">crate</span>::sys;
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::fmt;
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="doccomment">/// A collection of readiness events.
<a href=#7 id=7 data-nosnippet>7</a>///
<a href=#8 id=8 data-nosnippet>8</a>/// `Events` is passed as an argument to [`Poll::poll`] and will be used to
<a href=#9 id=9 data-nosnippet>9</a>/// receive any new readiness events received since the last poll. Usually, a
<a href=#10 id=10 data-nosnippet>10</a>/// single `Events` instance is created at the same time as a [`Poll`] and
<a href=#11 id=11 data-nosnippet>11</a>/// reused on each call to [`Poll::poll`].
<a href=#12 id=12 data-nosnippet>12</a>///
<a href=#13 id=13 data-nosnippet>13</a>/// See [`Poll`] for more documentation on polling.
<a href=#14 id=14 data-nosnippet>14</a>///
<a href=#15 id=15 data-nosnippet>15</a>/// [`Poll::poll`]: ../struct.Poll.html#method.poll
<a href=#16 id=16 data-nosnippet>16</a>/// [`Poll`]: ../struct.Poll.html
<a href=#17 id=17 data-nosnippet>17</a>///
<a href=#18 id=18 data-nosnippet>18</a>/// # Examples
<a href=#19 id=19 data-nosnippet>19</a>///
<a href=#20 id=20 data-nosnippet>20</a></span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#21 id=21 data-nosnippet>21</a>#[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#22 id=22 data-nosnippet>22</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#23 id=23 data-nosnippet>23</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#24 id=24 data-nosnippet>24</a>/// use mio::{Events, Poll};
<a href=#25 id=25 data-nosnippet>25</a>/// use std::time::Duration;
<a href=#26 id=26 data-nosnippet>26</a>///
<a href=#27 id=27 data-nosnippet>27</a>/// let mut events = Events::with_capacity(1024);
<a href=#28 id=28 data-nosnippet>28</a>/// let mut poll = Poll::new()?;
<a href=#29 id=29 data-nosnippet>29</a>/// #
<a href=#30 id=30 data-nosnippet>30</a>/// # assert!(events.is_empty());
<a href=#31 id=31 data-nosnippet>31</a>///
<a href=#32 id=32 data-nosnippet>32</a>/// // Register `event::Source`s with `poll`.
<a href=#33 id=33 data-nosnippet>33</a>///
<a href=#34 id=34 data-nosnippet>34</a>/// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#35 id=35 data-nosnippet>35</a>///
<a href=#36 id=36 data-nosnippet>36</a>/// for event in events.iter() {
<a href=#37 id=37 data-nosnippet>37</a>/// println!("Got an event for {:?}", event.token());
<a href=#38 id=38 data-nosnippet>38</a>/// }
<a href=#39 id=39 data-nosnippet>39</a>/// # Ok(())
<a href=#40 id=40 data-nosnippet>40</a>/// # }
<a href=#41 id=41 data-nosnippet>41</a>/// ```
<a href=#42 id=42 data-nosnippet>42</a></span><span class="kw">pub struct </span>Events {
<a href=#43 id=43 data-nosnippet>43</a> inner: sys::Events,
<a href=#44 id=44 data-nosnippet>44</a>}
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a><span class="doccomment">/// [`Events`] iterator.
<a href=#47 id=47 data-nosnippet>47</a>///
<a href=#48 id=48 data-nosnippet>48</a>/// This struct is created by the [`iter`] method on [`Events`].
<a href=#49 id=49 data-nosnippet>49</a>///
<a href=#50 id=50 data-nosnippet>50</a>/// [`Events`]: struct.Events.html
<a href=#51 id=51 data-nosnippet>51</a>/// [`iter`]: struct.Events.html#method.iter
<a href=#52 id=52 data-nosnippet>52</a>///
<a href=#53 id=53 data-nosnippet>53</a>/// # Examples
<a href=#54 id=54 data-nosnippet>54</a>///
<a href=#55 id=55 data-nosnippet>55</a></span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#56 id=56 data-nosnippet>56</a>#[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#57 id=57 data-nosnippet>57</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#58 id=58 data-nosnippet>58</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#59 id=59 data-nosnippet>59</a>/// use mio::{Events, Poll};
<a href=#60 id=60 data-nosnippet>60</a>/// use std::time::Duration;
<a href=#61 id=61 data-nosnippet>61</a>///
<a href=#62 id=62 data-nosnippet>62</a>/// let mut events = Events::with_capacity(1024);
<a href=#63 id=63 data-nosnippet>63</a>/// let mut poll = Poll::new()?;
<a href=#64 id=64 data-nosnippet>64</a>///
<a href=#65 id=65 data-nosnippet>65</a>/// // Register handles with `poll`.
<a href=#66 id=66 data-nosnippet>66</a>///
<a href=#67 id=67 data-nosnippet>67</a>/// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#68 id=68 data-nosnippet>68</a>///
<a href=#69 id=69 data-nosnippet>69</a>/// for event in events.iter() {
<a href=#70 id=70 data-nosnippet>70</a>/// println!("Got an event for {:?}", event.token());
<a href=#71 id=71 data-nosnippet>71</a>/// }
<a href=#72 id=72 data-nosnippet>72</a>/// # Ok(())
<a href=#73 id=73 data-nosnippet>73</a>/// # }
<a href=#74 id=74 data-nosnippet>74</a>/// ```
<a href=#75 id=75 data-nosnippet>75</a></span><span class="attr">#[derive(Debug, Clone)]
<a href=#76 id=76 data-nosnippet>76</a></span><span class="kw">pub struct </span>Iter&lt;<span class="lifetime">'a</span>&gt; {
<a href=#77 id=77 data-nosnippet>77</a> inner: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Events,
<a href=#78 id=78 data-nosnippet>78</a> pos: usize,
<a href=#79 id=79 data-nosnippet>79</a>}
<a href=#80 id=80 data-nosnippet>80</a>
<a href=#81 id=81 data-nosnippet>81</a><span class="kw">impl </span>Events {
<a href=#82 id=82 data-nosnippet>82</a> <span class="doccomment">/// Return a new `Events` capable of holding up to `capacity` events.
<a href=#83 id=83 data-nosnippet>83</a> ///
<a href=#84 id=84 data-nosnippet>84</a> /// # Examples
<a href=#85 id=85 data-nosnippet>85</a> ///
<a href=#86 id=86 data-nosnippet>86</a> /// ```
<a href=#87 id=87 data-nosnippet>87</a> /// use mio::Events;
<a href=#88 id=88 data-nosnippet>88</a> ///
<a href=#89 id=89 data-nosnippet>89</a> /// let events = Events::with_capacity(1024);
<a href=#90 id=90 data-nosnippet>90</a> /// assert_eq!(1024, events.capacity());
<a href=#91 id=91 data-nosnippet>91</a> /// ```
<a href=#92 id=92 data-nosnippet>92</a> </span><span class="kw">pub fn </span>with_capacity(capacity: usize) -&gt; Events {
<a href=#93 id=93 data-nosnippet>93</a> Events {
<a href=#94 id=94 data-nosnippet>94</a> inner: sys::Events::with_capacity(capacity),
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a>
<a href=#98 id=98 data-nosnippet>98</a> <span class="doccomment">/// Returns the number of `Event` values that `self` can hold.
<a href=#99 id=99 data-nosnippet>99</a> ///
<a href=#100 id=100 data-nosnippet>100</a> /// ```
<a href=#101 id=101 data-nosnippet>101</a> /// use mio::Events;
<a href=#102 id=102 data-nosnippet>102</a> ///
<a href=#103 id=103 data-nosnippet>103</a> /// let events = Events::with_capacity(1024);
<a href=#104 id=104 data-nosnippet>104</a> /// assert_eq!(1024, events.capacity());
<a href=#105 id=105 data-nosnippet>105</a> /// ```
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">pub fn </span>capacity(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#107 id=107 data-nosnippet>107</a> <span class="self">self</span>.inner.capacity()
<a href=#108 id=108 data-nosnippet>108</a> }
<a href=#109 id=109 data-nosnippet>109</a>
<a href=#110 id=110 data-nosnippet>110</a> <span class="doccomment">/// Returns `true` if `self` contains no `Event` values.
<a href=#111 id=111 data-nosnippet>111</a> ///
<a href=#112 id=112 data-nosnippet>112</a> /// # Examples
<a href=#113 id=113 data-nosnippet>113</a> ///
<a href=#114 id=114 data-nosnippet>114</a> /// ```
<a href=#115 id=115 data-nosnippet>115</a> /// use mio::Events;
<a href=#116 id=116 data-nosnippet>116</a> ///
<a href=#117 id=117 data-nosnippet>117</a> /// let events = Events::with_capacity(1024);
<a href=#118 id=118 data-nosnippet>118</a> /// assert!(events.is_empty());
<a href=#119 id=119 data-nosnippet>119</a> /// ```
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#121 id=121 data-nosnippet>121</a> <span class="self">self</span>.inner.is_empty()
<a href=#122 id=122 data-nosnippet>122</a> }
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="doccomment">/// Returns an iterator over the `Event` values.
<a href=#125 id=125 data-nosnippet>125</a> ///
<a href=#126 id=126 data-nosnippet>126</a> /// # Examples
<a href=#127 id=127 data-nosnippet>127</a> ///
<a href=#128 id=128 data-nosnippet>128</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#129 id=129 data-nosnippet>129</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#130 id=130 data-nosnippet>130</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#131 id=131 data-nosnippet>131</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#132 id=132 data-nosnippet>132</a> /// use mio::{Events, Poll};
<a href=#133 id=133 data-nosnippet>133</a> /// use std::time::Duration;
<a href=#134 id=134 data-nosnippet>134</a> ///
<a href=#135 id=135 data-nosnippet>135</a> /// let mut events = Events::with_capacity(1024);
<a href=#136 id=136 data-nosnippet>136</a> /// let mut poll = Poll::new()?;
<a href=#137 id=137 data-nosnippet>137</a> ///
<a href=#138 id=138 data-nosnippet>138</a> /// // Register handles with `poll`.
<a href=#139 id=139 data-nosnippet>139</a> ///
<a href=#140 id=140 data-nosnippet>140</a> /// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#141 id=141 data-nosnippet>141</a> ///
<a href=#142 id=142 data-nosnippet>142</a> /// for event in events.iter() {
<a href=#143 id=143 data-nosnippet>143</a> /// println!("Got an event for {:?}", event.token());
<a href=#144 id=144 data-nosnippet>144</a> /// }
<a href=#145 id=145 data-nosnippet>145</a> /// # Ok(())
<a href=#146 id=146 data-nosnippet>146</a> /// # }
<a href=#147 id=147 data-nosnippet>147</a> /// ```
<a href=#148 id=148 data-nosnippet>148</a> </span><span class="kw">pub fn </span>iter(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Iter&lt;<span class="lifetime">'_</span>&gt; {
<a href=#149 id=149 data-nosnippet>149</a> Iter {
<a href=#150 id=150 data-nosnippet>150</a> inner: <span class="self">self</span>,
<a href=#151 id=151 data-nosnippet>151</a> pos: <span class="number">0</span>,
<a href=#152 id=152 data-nosnippet>152</a> }
<a href=#153 id=153 data-nosnippet>153</a> }
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a> <span class="doccomment">/// Clearing all `Event` values from container explicitly.
<a href=#156 id=156 data-nosnippet>156</a> ///
<a href=#157 id=157 data-nosnippet>157</a> /// # Notes
<a href=#158 id=158 data-nosnippet>158</a> ///
<a href=#159 id=159 data-nosnippet>159</a> /// Events are cleared before every `poll`, so it is not required to call
<a href=#160 id=160 data-nosnippet>160</a> /// this manually.
<a href=#161 id=161 data-nosnippet>161</a> ///
<a href=#162 id=162 data-nosnippet>162</a> /// # Examples
<a href=#163 id=163 data-nosnippet>163</a> ///
<a href=#164 id=164 data-nosnippet>164</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#165 id=165 data-nosnippet>165</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#166 id=166 data-nosnippet>166</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#167 id=167 data-nosnippet>167</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#168 id=168 data-nosnippet>168</a> /// use mio::{Events, Poll};
<a href=#169 id=169 data-nosnippet>169</a> /// use std::time::Duration;
<a href=#170 id=170 data-nosnippet>170</a> ///
<a href=#171 id=171 data-nosnippet>171</a> /// let mut events = Events::with_capacity(1024);
<a href=#172 id=172 data-nosnippet>172</a> /// let mut poll = Poll::new()?;
<a href=#173 id=173 data-nosnippet>173</a> ///
<a href=#174 id=174 data-nosnippet>174</a> /// // Register handles with `poll`.
<a href=#175 id=175 data-nosnippet>175</a> ///
<a href=#176 id=176 data-nosnippet>176</a> /// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#177 id=177 data-nosnippet>177</a> ///
<a href=#178 id=178 data-nosnippet>178</a> /// // Clear all events.
<a href=#179 id=179 data-nosnippet>179</a> /// events.clear();
<a href=#180 id=180 data-nosnippet>180</a> /// assert!(events.is_empty());
<a href=#181 id=181 data-nosnippet>181</a> /// # Ok(())
<a href=#182 id=182 data-nosnippet>182</a> /// # }
<a href=#183 id=183 data-nosnippet>183</a> /// ```
<a href=#184 id=184 data-nosnippet>184</a> </span><span class="kw">pub fn </span>clear(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#185 id=185 data-nosnippet>185</a> <span class="self">self</span>.inner.clear();
<a href=#186 id=186 data-nosnippet>186</a> }
<a href=#187 id=187 data-nosnippet>187</a>
<a href=#188 id=188 data-nosnippet>188</a> <span class="doccomment">/// Returns the inner `sys::Events`.
<a href=#189 id=189 data-nosnippet>189</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>sys(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>sys::Events {
<a href=#190 id=190 data-nosnippet>190</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>.inner
<a href=#191 id=191 data-nosnippet>191</a> }
<a href=#192 id=192 data-nosnippet>192</a>}
<a href=#193 id=193 data-nosnippet>193</a>
<a href=#194 id=194 data-nosnippet>194</a><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; IntoIterator <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">'a </span>Events {
<a href=#195 id=195 data-nosnippet>195</a> <span class="kw">type </span>Item = <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Event;
<a href=#196 id=196 data-nosnippet>196</a> <span class="kw">type </span>IntoIter = Iter&lt;<span class="lifetime">'a</span>&gt;;
<a href=#197 id=197 data-nosnippet>197</a>
<a href=#198 id=198 data-nosnippet>198</a> <span class="kw">fn </span>into_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::IntoIter {
<a href=#199 id=199 data-nosnippet>199</a> <span class="self">self</span>.iter()
<a href=#200 id=200 data-nosnippet>200</a> }
<a href=#201 id=201 data-nosnippet>201</a>}
<a href=#202 id=202 data-nosnippet>202</a>
<a href=#203 id=203 data-nosnippet>203</a><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; Iterator <span class="kw">for </span>Iter&lt;<span class="lifetime">'a</span>&gt; {
<a href=#204 id=204 data-nosnippet>204</a> <span class="kw">type </span>Item = <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Event;
<a href=#205 id=205 data-nosnippet>205</a>
<a href=#206 id=206 data-nosnippet>206</a> <span class="kw">fn </span>next(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt; {
<a href=#207 id=207 data-nosnippet>207</a> <span class="kw">let </span>ret = <span class="self">self
<a href=#208 id=208 data-nosnippet>208</a> </span>.inner
<a href=#209 id=209 data-nosnippet>209</a> .inner
<a href=#210 id=210 data-nosnippet>210</a> .get(<span class="self">self</span>.pos)
<a href=#211 id=211 data-nosnippet>211</a> .map(Event::from_sys_event_ref);
<a href=#212 id=212 data-nosnippet>212</a> <span class="self">self</span>.pos += <span class="number">1</span>;
<a href=#213 id=213 data-nosnippet>213</a> ret
<a href=#214 id=214 data-nosnippet>214</a> }
<a href=#215 id=215 data-nosnippet>215</a>
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, <span class="prelude-ty">Option</span>&lt;usize&gt;) {
<a href=#217 id=217 data-nosnippet>217</a> <span class="kw">let </span>size = <span class="self">self</span>.inner.inner.len();
<a href=#218 id=218 data-nosnippet>218</a> (size, <span class="prelude-val">Some</span>(size))
<a href=#219 id=219 data-nosnippet>219</a> }
<a href=#220 id=220 data-nosnippet>220</a>
<a href=#221 id=221 data-nosnippet>221</a> <span class="kw">fn </span>count(<span class="self">self</span>) -&gt; usize {
<a href=#222 id=222 data-nosnippet>222</a> <span class="self">self</span>.inner.inner.len()
<a href=#223 id=223 data-nosnippet>223</a> }
<a href=#224 id=224 data-nosnippet>224</a>}
<a href=#225 id=225 data-nosnippet>225</a>
<a href=#226 id=226 data-nosnippet>226</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Events {
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#228 id=228 data-nosnippet>228</a> f.debug_list().entries(<span class="self">self</span>).finish()
<a href=#229 id=229 data-nosnippet>229</a> }
<a href=#230 id=230 data-nosnippet>230</a>}
</code></pre></div></section></main></body></html>
+11
View File
@@ -0,0 +1,11 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/event/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/event/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Readiness event types and utilities.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="attr">#[allow(clippy::module_inception)]
<a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">mod </span>event;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">mod </span>events;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">mod </span>source;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub use </span><span class="self">self</span>::event::Event;
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">pub use </span><span class="self">self</span>::events::{Events, Iter};
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">pub use </span><span class="self">self</span>::source::Source;
</code></pre></div></section></main></body></html>
+140
View File
@@ -0,0 +1,140 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/event/source.rs`."><title>source.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/event/</div>source.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{Interest, Registry, Token};
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::io;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="doccomment">/// An event source that may be registered with [`Registry`].
<a href=#6 id=6 data-nosnippet>6</a>///
<a href=#7 id=7 data-nosnippet>7</a>/// Types that implement `event::Source` can be registered with
<a href=#8 id=8 data-nosnippet>8</a>/// `Registry`. Users of Mio **should not** use the `event::Source` trait
<a href=#9 id=9 data-nosnippet>9</a>/// functions directly. Instead, the equivalent functions on `Registry` should
<a href=#10 id=10 data-nosnippet>10</a>/// be used.
<a href=#11 id=11 data-nosnippet>11</a>///
<a href=#12 id=12 data-nosnippet>12</a>/// See [`Registry`] for more details.
<a href=#13 id=13 data-nosnippet>13</a>///
<a href=#14 id=14 data-nosnippet>14</a>/// [`Registry`]: ../struct.Registry.html
<a href=#15 id=15 data-nosnippet>15</a>///
<a href=#16 id=16 data-nosnippet>16</a>/// # Implementing `event::Source`
<a href=#17 id=17 data-nosnippet>17</a>///
<a href=#18 id=18 data-nosnippet>18</a>/// Event sources are always backed by system handles, such as sockets or other
<a href=#19 id=19 data-nosnippet>19</a>/// system handles. These `event::Source`s will be monitored by the system
<a href=#20 id=20 data-nosnippet>20</a>/// selector. An implementation of `Source` will almost always delegates to a
<a href=#21 id=21 data-nosnippet>21</a>/// lower level handle. Examples of this are [`TcpStream`]s, or the *unix only*
<a href=#22 id=22 data-nosnippet>22</a>/// [`SourceFd`].
<a href=#23 id=23 data-nosnippet>23</a>///
<a href=#24 id=24 data-nosnippet>24</a>/// [`TcpStream`]: ../net/struct.TcpStream.html
<a href=#25 id=25 data-nosnippet>25</a>/// [`SourceFd`]: ../unix/struct.SourceFd.html
<a href=#26 id=26 data-nosnippet>26</a>///
<a href=#27 id=27 data-nosnippet>27</a>/// # Dropping `event::Source`s
<a href=#28 id=28 data-nosnippet>28</a>///
<a href=#29 id=29 data-nosnippet>29</a>/// All `event::Source`s, unless otherwise specified, need to be [deregistered]
<a href=#30 id=30 data-nosnippet>30</a>/// before being dropped for them to not leak resources. This goes against the
<a href=#31 id=31 data-nosnippet>31</a>/// normal drop behaviour of types in Rust which cleanup after themselves, e.g.
<a href=#32 id=32 data-nosnippet>32</a>/// a `File` will close itself. However since deregistering needs access to
<a href=#33 id=33 data-nosnippet>33</a>/// [`Registry`] this cannot be done while being dropped.
<a href=#34 id=34 data-nosnippet>34</a>///
<a href=#35 id=35 data-nosnippet>35</a>/// [deregistered]: ../struct.Registry.html#method.deregister
<a href=#36 id=36 data-nosnippet>36</a>///
<a href=#37 id=37 data-nosnippet>37</a>/// # Examples
<a href=#38 id=38 data-nosnippet>38</a>///
<a href=#39 id=39 data-nosnippet>39</a>/// Implementing `Source` on a struct containing a socket:
<a href=#40 id=40 data-nosnippet>40</a>///
<a href=#41 id=41 data-nosnippet>41</a></span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#42 id=42 data-nosnippet>42</a>#[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#43 id=43 data-nosnippet>43</a></span><span class="doccomment">/// use mio::{Interest, Registry, Token};
<a href=#44 id=44 data-nosnippet>44</a>/// use mio::event::Source;
<a href=#45 id=45 data-nosnippet>45</a>/// use mio::net::TcpStream;
<a href=#46 id=46 data-nosnippet>46</a>///
<a href=#47 id=47 data-nosnippet>47</a>/// use std::io;
<a href=#48 id=48 data-nosnippet>48</a>///
<a href=#49 id=49 data-nosnippet>49</a>/// # #[allow(dead_code)]
<a href=#50 id=50 data-nosnippet>50</a>/// pub struct MySource {
<a href=#51 id=51 data-nosnippet>51</a>/// socket: TcpStream,
<a href=#52 id=52 data-nosnippet>52</a>/// }
<a href=#53 id=53 data-nosnippet>53</a>///
<a href=#54 id=54 data-nosnippet>54</a>/// impl Source for MySource {
<a href=#55 id=55 data-nosnippet>55</a>/// fn register(&amp;mut self, registry: &amp;Registry, token: Token, interests: Interest)
<a href=#56 id=56 data-nosnippet>56</a>/// -&gt; io::Result&lt;()&gt;
<a href=#57 id=57 data-nosnippet>57</a>/// {
<a href=#58 id=58 data-nosnippet>58</a>/// // Delegate the `register` call to `socket`
<a href=#59 id=59 data-nosnippet>59</a>/// self.socket.register(registry, token, interests)
<a href=#60 id=60 data-nosnippet>60</a>/// }
<a href=#61 id=61 data-nosnippet>61</a>///
<a href=#62 id=62 data-nosnippet>62</a>/// fn reregister(&amp;mut self, registry: &amp;Registry, token: Token, interests: Interest)
<a href=#63 id=63 data-nosnippet>63</a>/// -&gt; io::Result&lt;()&gt;
<a href=#64 id=64 data-nosnippet>64</a>/// {
<a href=#65 id=65 data-nosnippet>65</a>/// // Delegate the `reregister` call to `socket`
<a href=#66 id=66 data-nosnippet>66</a>/// self.socket.reregister(registry, token, interests)
<a href=#67 id=67 data-nosnippet>67</a>/// }
<a href=#68 id=68 data-nosnippet>68</a>///
<a href=#69 id=69 data-nosnippet>69</a>/// fn deregister(&amp;mut self, registry: &amp;Registry) -&gt; io::Result&lt;()&gt; {
<a href=#70 id=70 data-nosnippet>70</a>/// // Delegate the `deregister` call to `socket`
<a href=#71 id=71 data-nosnippet>71</a>/// self.socket.deregister(registry)
<a href=#72 id=72 data-nosnippet>72</a>/// }
<a href=#73 id=73 data-nosnippet>73</a>/// }
<a href=#74 id=74 data-nosnippet>74</a>/// ```
<a href=#75 id=75 data-nosnippet>75</a></span><span class="kw">pub trait </span>Source {
<a href=#76 id=76 data-nosnippet>76</a> <span class="doccomment">/// Register `self` with the given `Registry` instance.
<a href=#77 id=77 data-nosnippet>77</a> ///
<a href=#78 id=78 data-nosnippet>78</a> /// This function should not be called directly. Use [`Registry::register`]
<a href=#79 id=79 data-nosnippet>79</a> /// instead. Implementors should handle registration by delegating the call
<a href=#80 id=80 data-nosnippet>80</a> /// to another `Source` type.
<a href=#81 id=81 data-nosnippet>81</a> ///
<a href=#82 id=82 data-nosnippet>82</a> /// [`Registry::register`]: ../struct.Registry.html#method.register
<a href=#83 id=83 data-nosnippet>83</a> </span><span class="kw">fn </span>register(
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#85 id=85 data-nosnippet>85</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#86 id=86 data-nosnippet>86</a> token: Token,
<a href=#87 id=87 data-nosnippet>87</a> interests: Interest,
<a href=#88 id=88 data-nosnippet>88</a> ) -&gt; io::Result&lt;()&gt;;
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a> <span class="doccomment">/// Re-register `self` with the given `Registry` instance.
<a href=#91 id=91 data-nosnippet>91</a> ///
<a href=#92 id=92 data-nosnippet>92</a> /// This function should not be called directly. Use
<a href=#93 id=93 data-nosnippet>93</a> /// [`Registry::reregister`] instead. Implementors should handle
<a href=#94 id=94 data-nosnippet>94</a> /// re-registration by either delegating the call to another `Source` type.
<a href=#95 id=95 data-nosnippet>95</a> ///
<a href=#96 id=96 data-nosnippet>96</a> /// [`Registry::reregister`]: ../struct.Registry.html#method.reregister
<a href=#97 id=97 data-nosnippet>97</a> </span><span class="kw">fn </span>reregister(
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#99 id=99 data-nosnippet>99</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#100 id=100 data-nosnippet>100</a> token: Token,
<a href=#101 id=101 data-nosnippet>101</a> interests: Interest,
<a href=#102 id=102 data-nosnippet>102</a> ) -&gt; io::Result&lt;()&gt;;
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> <span class="doccomment">/// Deregister `self` from the given `Registry` instance.
<a href=#105 id=105 data-nosnippet>105</a> ///
<a href=#106 id=106 data-nosnippet>106</a> /// This function should not be called directly. Use
<a href=#107 id=107 data-nosnippet>107</a> /// [`Registry::deregister`] instead. Implementors should handle
<a href=#108 id=108 data-nosnippet>108</a> /// deregistration by delegating the call to another `Source` type.
<a href=#109 id=109 data-nosnippet>109</a> ///
<a href=#110 id=110 data-nosnippet>110</a> /// [`Registry::deregister`]: ../struct.Registry.html#method.deregister
<a href=#111 id=111 data-nosnippet>111</a> </span><span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt;;
<a href=#112 id=112 data-nosnippet>112</a>}
<a href=#113 id=113 data-nosnippet>113</a>
<a href=#114 id=114 data-nosnippet>114</a><span class="kw">impl</span>&lt;T&gt; Source <span class="kw">for </span>Box&lt;T&gt;
<a href=#115 id=115 data-nosnippet>115</a><span class="kw">where
<a href=#116 id=116 data-nosnippet>116</a> </span>T: Source + <span class="question-mark">?</span>Sized,
<a href=#117 id=117 data-nosnippet>117</a>{
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">fn </span>register(
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#120 id=120 data-nosnippet>120</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#121 id=121 data-nosnippet>121</a> token: Token,
<a href=#122 id=122 data-nosnippet>122</a> interests: Interest,
<a href=#123 id=123 data-nosnippet>123</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#124 id=124 data-nosnippet>124</a> (<span class="kw-2">**</span><span class="self">self</span>).register(registry, token, interests)
<a href=#125 id=125 data-nosnippet>125</a> }
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">fn </span>reregister(
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#129 id=129 data-nosnippet>129</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#130 id=130 data-nosnippet>130</a> token: Token,
<a href=#131 id=131 data-nosnippet>131</a> interests: Interest,
<a href=#132 id=132 data-nosnippet>132</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#133 id=133 data-nosnippet>133</a> (<span class="kw-2">**</span><span class="self">self</span>).reregister(registry, token, interests)
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#137 id=137 data-nosnippet>137</a> (<span class="kw-2">**</span><span class="self">self</span>).deregister(registry)
<a href=#138 id=138 data-nosnippet>138</a> }
<a href=#139 id=139 data-nosnippet>139</a>}
</code></pre></div></section></main></body></html>
+203
View File
@@ -0,0 +1,203 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/interest.rs`."><title>interest.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>interest.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::num::NonZeroU8;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::{fmt, ops};
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Interest used in registering.
<a href=#5 id=5 data-nosnippet>5</a>///
<a href=#6 id=6 data-nosnippet>6</a>/// Interest are used in [registering] [`event::Source`]s with [`Poll`], they
<a href=#7 id=7 data-nosnippet>7</a>/// indicate what readiness should be monitored for. For example if a socket is
<a href=#8 id=8 data-nosnippet>8</a>/// registered with [readable] interests and the socket becomes writable, no
<a href=#9 id=9 data-nosnippet>9</a>/// event will be returned from a call to [`poll`].
<a href=#10 id=10 data-nosnippet>10</a>///
<a href=#11 id=11 data-nosnippet>11</a>/// [registering]: struct.Registry.html#method.register
<a href=#12 id=12 data-nosnippet>12</a>/// [`event::Source`]: ./event/trait.Source.html
<a href=#13 id=13 data-nosnippet>13</a>/// [`Poll`]: struct.Poll.html
<a href=#14 id=14 data-nosnippet>14</a>/// [readable]: struct.Interest.html#associatedconstant.READABLE
<a href=#15 id=15 data-nosnippet>15</a>/// [`poll`]: struct.Poll.html#method.poll
<a href=#16 id=16 data-nosnippet>16</a></span><span class="attr">#[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord)]
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">pub struct </span>Interest(NonZeroU8);
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="comment">// These must be unique.
<a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">const </span>READABLE: u8 = <span class="number">0b0001</span>;
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">const </span>WRITABLE: u8 = <span class="number">0b0010</span>;
<a href=#22 id=22 data-nosnippet>22</a><span class="comment">// The following are not available on all platforms.
<a href=#23 id=23 data-nosnippet>23</a></span><span class="kw">const </span>AIO: u8 = <span class="number">0b0100</span>;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">const </span>LIO: u8 = <span class="number">0b1000</span>;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">const </span>PRIORITY: u8 = <span class="number">0b10000</span>;
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">impl </span>Interest {
<a href=#28 id=28 data-nosnippet>28</a> <span class="doccomment">/// Returns a `Interest` set representing readable interests.
<a href=#29 id=29 data-nosnippet>29</a> </span><span class="kw">pub const </span>READABLE: Interest = Interest(<span class="kw">unsafe </span>{ NonZeroU8::new_unchecked(READABLE) });
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a> <span class="doccomment">/// Returns a `Interest` set representing writable interests.
<a href=#32 id=32 data-nosnippet>32</a> </span><span class="kw">pub const </span>WRITABLE: Interest = Interest(<span class="kw">unsafe </span>{ NonZeroU8::new_unchecked(WRITABLE) });
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> <span class="doccomment">/// Returns a `Interest` set representing AIO completion interests.
<a href=#35 id=35 data-nosnippet>35</a> </span><span class="attr">#[cfg(any(
<a href=#36 id=36 data-nosnippet>36</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#37 id=37 data-nosnippet>37</a> target_os = <span class="string">"freebsd"</span>,
<a href=#38 id=38 data-nosnippet>38</a> target_os = <span class="string">"ios"</span>,
<a href=#39 id=39 data-nosnippet>39</a> target_os = <span class="string">"macos"</span>,
<a href=#40 id=40 data-nosnippet>40</a> target_os = <span class="string">"tvos"</span>,
<a href=#41 id=41 data-nosnippet>41</a> target_os = <span class="string">"visionos"</span>,
<a href=#42 id=42 data-nosnippet>42</a> target_os = <span class="string">"watchos"</span>,
<a href=#43 id=43 data-nosnippet>43</a> ))]
<a href=#44 id=44 data-nosnippet>44</a> </span><span class="kw">pub const </span>AIO: Interest = Interest(<span class="kw">unsafe </span>{ NonZeroU8::new_unchecked(AIO) });
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="doccomment">/// Returns a `Interest` set representing LIO completion interests.
<a href=#47 id=47 data-nosnippet>47</a> </span><span class="attr">#[cfg(target_os = <span class="string">"freebsd"</span>)]
<a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">pub const </span>LIO: Interest = Interest(<span class="kw">unsafe </span>{ NonZeroU8::new_unchecked(LIO) });
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a> <span class="doccomment">/// Returns a `Interest` set representing priority completion interests.
<a href=#51 id=51 data-nosnippet>51</a> </span><span class="attr">#[cfg(any(target_os = <span class="string">"linux"</span>, target_os = <span class="string">"android"</span>))]
<a href=#52 id=52 data-nosnippet>52</a> </span><span class="kw">pub const </span>PRIORITY: Interest = Interest(<span class="kw">unsafe </span>{ NonZeroU8::new_unchecked(PRIORITY) });
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a> <span class="doccomment">/// Add together two `Interest`.
<a href=#55 id=55 data-nosnippet>55</a> ///
<a href=#56 id=56 data-nosnippet>56</a> /// This does the same thing as the `BitOr` implementation, but is a
<a href=#57 id=57 data-nosnippet>57</a> /// constant function.
<a href=#58 id=58 data-nosnippet>58</a> ///
<a href=#59 id=59 data-nosnippet>59</a> /// ```
<a href=#60 id=60 data-nosnippet>60</a> /// use mio::Interest;
<a href=#61 id=61 data-nosnippet>61</a> ///
<a href=#62 id=62 data-nosnippet>62</a> /// const INTERESTS: Interest = Interest::READABLE.add(Interest::WRITABLE);
<a href=#63 id=63 data-nosnippet>63</a> /// # fn silent_dead_code_warning(_: Interest) { }
<a href=#64 id=64 data-nosnippet>64</a> /// # silent_dead_code_warning(INTERESTS)
<a href=#65 id=65 data-nosnippet>65</a> /// ```
<a href=#66 id=66 data-nosnippet>66</a> </span><span class="attr">#[allow(clippy::should_implement_trait)]
<a href=#67 id=67 data-nosnippet>67</a> #[must_use = <span class="string">"this returns the result of the operation, without modifying the original"</span>]
<a href=#68 id=68 data-nosnippet>68</a> </span><span class="kw">pub const fn </span>add(<span class="self">self</span>, other: Interest) -&gt; Interest {
<a href=#69 id=69 data-nosnippet>69</a> Interest(<span class="kw">unsafe </span>{ NonZeroU8::new_unchecked(<span class="self">self</span>.<span class="number">0</span>.get() | other.<span class="number">0</span>.get()) })
<a href=#70 id=70 data-nosnippet>70</a> }
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a> <span class="doccomment">/// Removes `other` `Interest` from `self`.
<a href=#73 id=73 data-nosnippet>73</a> ///
<a href=#74 id=74 data-nosnippet>74</a> /// Returns `None` if the set would be empty after removing `other`.
<a href=#75 id=75 data-nosnippet>75</a> ///
<a href=#76 id=76 data-nosnippet>76</a> /// ```
<a href=#77 id=77 data-nosnippet>77</a> /// use mio::Interest;
<a href=#78 id=78 data-nosnippet>78</a> ///
<a href=#79 id=79 data-nosnippet>79</a> /// const RW_INTERESTS: Interest = Interest::READABLE.add(Interest::WRITABLE);
<a href=#80 id=80 data-nosnippet>80</a> ///
<a href=#81 id=81 data-nosnippet>81</a> /// // As long a one interest remain this will return `Some`.
<a href=#82 id=82 data-nosnippet>82</a> /// let w_interest = RW_INTERESTS.remove(Interest::READABLE).unwrap();
<a href=#83 id=83 data-nosnippet>83</a> /// assert!(!w_interest.is_readable());
<a href=#84 id=84 data-nosnippet>84</a> /// assert!(w_interest.is_writable());
<a href=#85 id=85 data-nosnippet>85</a> ///
<a href=#86 id=86 data-nosnippet>86</a> /// // Removing all interests from the set will return `None`.
<a href=#87 id=87 data-nosnippet>87</a> /// assert_eq!(w_interest.remove(Interest::WRITABLE), None);
<a href=#88 id=88 data-nosnippet>88</a> ///
<a href=#89 id=89 data-nosnippet>89</a> /// // Its also possible to remove multiple interests at once.
<a href=#90 id=90 data-nosnippet>90</a> /// assert_eq!(RW_INTERESTS.remove(RW_INTERESTS), None);
<a href=#91 id=91 data-nosnippet>91</a> /// ```
<a href=#92 id=92 data-nosnippet>92</a> </span><span class="attr">#[must_use = <span class="string">"this returns the result of the operation, without modifying the original"</span>]
<a href=#93 id=93 data-nosnippet>93</a> </span><span class="kw">pub fn </span>remove(<span class="self">self</span>, other: Interest) -&gt; <span class="prelude-ty">Option</span>&lt;Interest&gt; {
<a href=#94 id=94 data-nosnippet>94</a> NonZeroU8::new(<span class="self">self</span>.<span class="number">0</span>.get() &amp; !other.<span class="number">0</span>.get()).map(Interest)
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a>
<a href=#97 id=97 data-nosnippet>97</a> <span class="doccomment">/// Returns true if the value includes readable readiness.
<a href=#98 id=98 data-nosnippet>98</a> </span><span class="attr">#[must_use]
<a href=#99 id=99 data-nosnippet>99</a> </span><span class="kw">pub const fn </span>is_readable(<span class="self">self</span>) -&gt; bool {
<a href=#100 id=100 data-nosnippet>100</a> (<span class="self">self</span>.<span class="number">0</span>.get() &amp; READABLE) != <span class="number">0
<a href=#101 id=101 data-nosnippet>101</a> </span>}
<a href=#102 id=102 data-nosnippet>102</a>
<a href=#103 id=103 data-nosnippet>103</a> <span class="doccomment">/// Returns true if the value includes writable readiness.
<a href=#104 id=104 data-nosnippet>104</a> </span><span class="attr">#[must_use]
<a href=#105 id=105 data-nosnippet>105</a> </span><span class="kw">pub const fn </span>is_writable(<span class="self">self</span>) -&gt; bool {
<a href=#106 id=106 data-nosnippet>106</a> (<span class="self">self</span>.<span class="number">0</span>.get() &amp; WRITABLE) != <span class="number">0
<a href=#107 id=107 data-nosnippet>107</a> </span>}
<a href=#108 id=108 data-nosnippet>108</a>
<a href=#109 id=109 data-nosnippet>109</a> <span class="doccomment">/// Returns true if `Interest` contains AIO readiness.
<a href=#110 id=110 data-nosnippet>110</a> </span><span class="attr">#[must_use]
<a href=#111 id=111 data-nosnippet>111</a> </span><span class="kw">pub const fn </span>is_aio(<span class="self">self</span>) -&gt; bool {
<a href=#112 id=112 data-nosnippet>112</a> (<span class="self">self</span>.<span class="number">0</span>.get() &amp; AIO) != <span class="number">0
<a href=#113 id=113 data-nosnippet>113</a> </span>}
<a href=#114 id=114 data-nosnippet>114</a>
<a href=#115 id=115 data-nosnippet>115</a> <span class="doccomment">/// Returns true if `Interest` contains LIO readiness.
<a href=#116 id=116 data-nosnippet>116</a> </span><span class="attr">#[must_use]
<a href=#117 id=117 data-nosnippet>117</a> </span><span class="kw">pub const fn </span>is_lio(<span class="self">self</span>) -&gt; bool {
<a href=#118 id=118 data-nosnippet>118</a> (<span class="self">self</span>.<span class="number">0</span>.get() &amp; LIO) != <span class="number">0
<a href=#119 id=119 data-nosnippet>119</a> </span>}
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a> <span class="doccomment">/// Returns true if `Interest` contains priority readiness.
<a href=#122 id=122 data-nosnippet>122</a> </span><span class="attr">#[must_use]
<a href=#123 id=123 data-nosnippet>123</a> </span><span class="kw">pub const fn </span>is_priority(<span class="self">self</span>) -&gt; bool {
<a href=#124 id=124 data-nosnippet>124</a> (<span class="self">self</span>.<span class="number">0</span>.get() &amp; PRIORITY) != <span class="number">0
<a href=#125 id=125 data-nosnippet>125</a> </span>}
<a href=#126 id=126 data-nosnippet>126</a>}
<a href=#127 id=127 data-nosnippet>127</a>
<a href=#128 id=128 data-nosnippet>128</a><span class="kw">impl </span>ops::BitOr <span class="kw">for </span>Interest {
<a href=#129 id=129 data-nosnippet>129</a> <span class="kw">type </span>Output = <span class="self">Self</span>;
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> <span class="attr">#[inline]
<a href=#132 id=132 data-nosnippet>132</a> </span><span class="kw">fn </span>bitor(<span class="self">self</span>, other: <span class="self">Self</span>) -&gt; <span class="self">Self </span>{
<a href=#133 id=133 data-nosnippet>133</a> <span class="self">self</span>.add(other)
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>}
<a href=#136 id=136 data-nosnippet>136</a>
<a href=#137 id=137 data-nosnippet>137</a><span class="kw">impl </span>ops::BitOrAssign <span class="kw">for </span>Interest {
<a href=#138 id=138 data-nosnippet>138</a> <span class="attr">#[inline]
<a href=#139 id=139 data-nosnippet>139</a> </span><span class="kw">fn </span>bitor_assign(<span class="kw-2">&amp;mut </span><span class="self">self</span>, other: <span class="self">Self</span>) {
<a href=#140 id=140 data-nosnippet>140</a> <span class="self">self</span>.<span class="number">0 </span>= (<span class="kw-2">*</span><span class="self">self </span>| other).<span class="number">0</span>;
<a href=#141 id=141 data-nosnippet>141</a> }
<a href=#142 id=142 data-nosnippet>142</a>}
<a href=#143 id=143 data-nosnippet>143</a>
<a href=#144 id=144 data-nosnippet>144</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Interest {
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">let </span><span class="kw-2">mut </span>one = <span class="bool-val">false</span>;
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">if </span><span class="self">self</span>.is_readable() {
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">if </span>one {
<a href=#149 id=149 data-nosnippet>149</a> <span class="macro">write!</span>(fmt, <span class="string">" | "</span>)<span class="question-mark">?
<a href=#150 id=150 data-nosnippet>150</a> </span>}
<a href=#151 id=151 data-nosnippet>151</a> <span class="macro">write!</span>(fmt, <span class="string">"READABLE"</span>)<span class="question-mark">?</span>;
<a href=#152 id=152 data-nosnippet>152</a> one = <span class="bool-val">true
<a href=#153 id=153 data-nosnippet>153</a> </span>}
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">if </span><span class="self">self</span>.is_writable() {
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">if </span>one {
<a href=#156 id=156 data-nosnippet>156</a> <span class="macro">write!</span>(fmt, <span class="string">" | "</span>)<span class="question-mark">?
<a href=#157 id=157 data-nosnippet>157</a> </span>}
<a href=#158 id=158 data-nosnippet>158</a> <span class="macro">write!</span>(fmt, <span class="string">"WRITABLE"</span>)<span class="question-mark">?</span>;
<a href=#159 id=159 data-nosnippet>159</a> one = <span class="bool-val">true
<a href=#160 id=160 data-nosnippet>160</a> </span>}
<a href=#161 id=161 data-nosnippet>161</a> <span class="attr">#[cfg(any(
<a href=#162 id=162 data-nosnippet>162</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#163 id=163 data-nosnippet>163</a> target_os = <span class="string">"freebsd"</span>,
<a href=#164 id=164 data-nosnippet>164</a> target_os = <span class="string">"ios"</span>,
<a href=#165 id=165 data-nosnippet>165</a> target_os = <span class="string">"macos"</span>,
<a href=#166 id=166 data-nosnippet>166</a> target_os = <span class="string">"tvos"</span>,
<a href=#167 id=167 data-nosnippet>167</a> target_os = <span class="string">"visionos"</span>,
<a href=#168 id=168 data-nosnippet>168</a> target_os = <span class="string">"watchos"</span>,
<a href=#169 id=169 data-nosnippet>169</a> ))]
<a href=#170 id=170 data-nosnippet>170</a> </span>{
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">if </span><span class="self">self</span>.is_aio() {
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">if </span>one {
<a href=#173 id=173 data-nosnippet>173</a> <span class="macro">write!</span>(fmt, <span class="string">" | "</span>)<span class="question-mark">?
<a href=#174 id=174 data-nosnippet>174</a> </span>}
<a href=#175 id=175 data-nosnippet>175</a> <span class="macro">write!</span>(fmt, <span class="string">"AIO"</span>)<span class="question-mark">?</span>;
<a href=#176 id=176 data-nosnippet>176</a> one = <span class="bool-val">true
<a href=#177 id=177 data-nosnippet>177</a> </span>}
<a href=#178 id=178 data-nosnippet>178</a> }
<a href=#179 id=179 data-nosnippet>179</a> <span class="attr">#[cfg(target_os = <span class="string">"freebsd"</span>)]
<a href=#180 id=180 data-nosnippet>180</a> </span>{
<a href=#181 id=181 data-nosnippet>181</a> <span class="kw">if </span><span class="self">self</span>.is_lio() {
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw">if </span>one {
<a href=#183 id=183 data-nosnippet>183</a> <span class="macro">write!</span>(fmt, <span class="string">" | "</span>)<span class="question-mark">?
<a href=#184 id=184 data-nosnippet>184</a> </span>}
<a href=#185 id=185 data-nosnippet>185</a> <span class="macro">write!</span>(fmt, <span class="string">"LIO"</span>)<span class="question-mark">?</span>;
<a href=#186 id=186 data-nosnippet>186</a> one = <span class="bool-val">true
<a href=#187 id=187 data-nosnippet>187</a> </span>}
<a href=#188 id=188 data-nosnippet>188</a> }
<a href=#189 id=189 data-nosnippet>189</a> <span class="attr">#[cfg(any(target_os = <span class="string">"linux"</span>, target_os = <span class="string">"android"</span>))]
<a href=#190 id=190 data-nosnippet>190</a> </span>{
<a href=#191 id=191 data-nosnippet>191</a> <span class="kw">if </span><span class="self">self</span>.is_priority() {
<a href=#192 id=192 data-nosnippet>192</a> <span class="kw">if </span>one {
<a href=#193 id=193 data-nosnippet>193</a> <span class="macro">write!</span>(fmt, <span class="string">" | "</span>)<span class="question-mark">?
<a href=#194 id=194 data-nosnippet>194</a> </span>}
<a href=#195 id=195 data-nosnippet>195</a> <span class="macro">write!</span>(fmt, <span class="string">"PRIORITY"</span>)<span class="question-mark">?</span>;
<a href=#196 id=196 data-nosnippet>196</a> one = <span class="bool-val">true
<a href=#197 id=197 data-nosnippet>197</a> </span>}
<a href=#198 id=198 data-nosnippet>198</a> }
<a href=#199 id=199 data-nosnippet>199</a> <span class="macro">debug_assert!</span>(one, <span class="string">"printing empty interests"</span>);
<a href=#200 id=200 data-nosnippet>200</a> <span class="prelude-val">Ok</span>(())
<a href=#201 id=201 data-nosnippet>201</a> }
<a href=#202 id=202 data-nosnippet>202</a>}
</code></pre></div></section></main></body></html>
+308
View File
@@ -0,0 +1,308 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/io_source.rs`."><title>io_source.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>io_source.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::ops::{Deref, DerefMut};
<a href=#2 id=2 data-nosnippet>2</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"wasi"</span>))]
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>std::os::fd::AsRawFd;
<a href=#4 id=4 data-nosnippet>4</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#5 id=5 data-nosnippet>5</a>// can use `std::os::fd` and be merged with the above.
<a href=#6 id=6 data-nosnippet>6</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">use </span>std::os::hermit::io::AsRawFd;
<a href=#8 id=8 data-nosnippet>8</a><span class="attr">#[cfg(windows)]
<a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">use </span>std::os::windows::io::AsRawSocket;
<a href=#10 id=10 data-nosnippet>10</a><span class="attr">#[cfg(debug_assertions)]
<a href=#11 id=11 data-nosnippet>11</a></span><span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering};
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>std::{fmt, io};
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">use </span><span class="kw">crate</span>::sys::IoSourceState;
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">use crate</span>::{event, Interest, Registry, Token};
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="doccomment">/// Adapter for a [`RawFd`] or [`RawSocket`] providing an [`event::Source`]
<a href=#18 id=18 data-nosnippet>18</a>/// implementation.
<a href=#19 id=19 data-nosnippet>19</a>///
<a href=#20 id=20 data-nosnippet>20</a>/// `IoSource` enables registering any FD or socket wrapper with [`Poll`].
<a href=#21 id=21 data-nosnippet>21</a>///
<a href=#22 id=22 data-nosnippet>22</a>/// While only implementations for TCP, UDP, and UDS (Unix only) are provided,
<a href=#23 id=23 data-nosnippet>23</a>/// Mio supports registering any FD or socket that can be registered with the
<a href=#24 id=24 data-nosnippet>24</a>/// underlying OS selector. `IoSource` provides the necessary bridge.
<a href=#25 id=25 data-nosnippet>25</a>///
<a href=#26 id=26 data-nosnippet>26</a>/// [`RawFd`]: std::os::fd::RawFd
<a href=#27 id=27 data-nosnippet>27</a>/// [`RawSocket`]: std::os::windows::io::RawSocket
<a href=#28 id=28 data-nosnippet>28</a>///
<a href=#29 id=29 data-nosnippet>29</a>/// # Notes
<a href=#30 id=30 data-nosnippet>30</a>///
<a href=#31 id=31 data-nosnippet>31</a>/// To handle the registrations and events properly **all** I/O operations (such
<a href=#32 id=32 data-nosnippet>32</a>/// as `read`, `write`, etc.) must go through the [`do_io`] method to ensure the
<a href=#33 id=33 data-nosnippet>33</a>/// internal state is updated accordingly.
<a href=#34 id=34 data-nosnippet>34</a>///
<a href=#35 id=35 data-nosnippet>35</a>/// [`Poll`]: crate::Poll
<a href=#36 id=36 data-nosnippet>36</a>/// [`do_io`]: IoSource::do_io
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">pub struct </span>IoSource&lt;T&gt; {
<a href=#38 id=38 data-nosnippet>38</a> state: IoSourceState,
<a href=#39 id=39 data-nosnippet>39</a> inner: T,
<a href=#40 id=40 data-nosnippet>40</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#41 id=41 data-nosnippet>41</a> </span>selector_id: SelectorId,
<a href=#42 id=42 data-nosnippet>42</a>}
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</a><span class="kw">impl</span>&lt;T&gt; IoSource&lt;T&gt; {
<a href=#45 id=45 data-nosnippet>45</a> <span class="doccomment">/// Create a new `IoSource`.
<a href=#46 id=46 data-nosnippet>46</a> </span><span class="kw">pub fn </span>new(io: T) -&gt; IoSource&lt;T&gt; {
<a href=#47 id=47 data-nosnippet>47</a> IoSource {
<a href=#48 id=48 data-nosnippet>48</a> state: IoSourceState::new(),
<a href=#49 id=49 data-nosnippet>49</a> inner: io,
<a href=#50 id=50 data-nosnippet>50</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#51 id=51 data-nosnippet>51</a> </span>selector_id: SelectorId::new(),
<a href=#52 id=52 data-nosnippet>52</a> }
<a href=#53 id=53 data-nosnippet>53</a> }
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a> <span class="doccomment">/// Execute an I/O operations ensuring that the socket receives more events
<a href=#56 id=56 data-nosnippet>56</a> /// if it hits a [`WouldBlock`] error.
<a href=#57 id=57 data-nosnippet>57</a> ///
<a href=#58 id=58 data-nosnippet>58</a> /// # Notes
<a href=#59 id=59 data-nosnippet>59</a> ///
<a href=#60 id=60 data-nosnippet>60</a> /// This method is required to be called for **all** I/O operations to
<a href=#61 id=61 data-nosnippet>61</a> /// ensure the user will receive events once the socket is ready again after
<a href=#62 id=62 data-nosnippet>62</a> /// returning a [`WouldBlock`] error.
<a href=#63 id=63 data-nosnippet>63</a> ///
<a href=#64 id=64 data-nosnippet>64</a> /// [`WouldBlock`]: io::ErrorKind::WouldBlock
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">pub fn </span>do_io&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; io::Result&lt;R&gt;
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">where
<a href=#67 id=67 data-nosnippet>67</a> </span>F: FnOnce(<span class="kw-2">&amp;</span>T) -&gt; io::Result&lt;R&gt;,
<a href=#68 id=68 data-nosnippet>68</a> {
<a href=#69 id=69 data-nosnippet>69</a> <span class="self">self</span>.state.do_io(f, <span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#70 id=70 data-nosnippet>70</a> }
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a> <span class="doccomment">/// Returns the I/O source, dropping the state.
<a href=#73 id=73 data-nosnippet>73</a> ///
<a href=#74 id=74 data-nosnippet>74</a> /// # Notes
<a href=#75 id=75 data-nosnippet>75</a> ///
<a href=#76 id=76 data-nosnippet>76</a> /// To ensure no more events are to be received for this I/O source first
<a href=#77 id=77 data-nosnippet>77</a> /// [`deregister`] it.
<a href=#78 id=78 data-nosnippet>78</a> ///
<a href=#79 id=79 data-nosnippet>79</a> /// [`deregister`]: Registry::deregister
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -&gt; T {
<a href=#81 id=81 data-nosnippet>81</a> <span class="self">self</span>.inner
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a>}
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a><span class="doccomment">/// Be careful when using this method. All I/O operations that may block must go
<a href=#86 id=86 data-nosnippet>86</a>/// through the [`do_io`] method.
<a href=#87 id=87 data-nosnippet>87</a>///
<a href=#88 id=88 data-nosnippet>88</a>/// [`do_io`]: IoSource::do_io
<a href=#89 id=89 data-nosnippet>89</a></span><span class="kw">impl</span>&lt;T&gt; Deref <span class="kw">for </span>IoSource&lt;T&gt; {
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">type </span>Target = T;
<a href=#91 id=91 data-nosnippet>91</a>
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">fn </span>deref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="self">Self</span>::Target {
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw-2">&amp;</span><span class="self">self</span>.inner
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a>}
<a href=#96 id=96 data-nosnippet>96</a>
<a href=#97 id=97 data-nosnippet>97</a><span class="doccomment">/// Be careful when using this method. All I/O operations that may block must go
<a href=#98 id=98 data-nosnippet>98</a>/// through the [`do_io`] method.
<a href=#99 id=99 data-nosnippet>99</a>///
<a href=#100 id=100 data-nosnippet>100</a>/// [`do_io`]: IoSource::do_io
<a href=#101 id=101 data-nosnippet>101</a></span><span class="kw">impl</span>&lt;T&gt; DerefMut <span class="kw">for </span>IoSource&lt;T&gt; {
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">fn </span>deref_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self</span>::Target {
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>.inner
<a href=#104 id=104 data-nosnippet>104</a> }
<a href=#105 id=105 data-nosnippet>105</a>}
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>))]
<a href=#108 id=108 data-nosnippet>108</a></span><span class="kw">impl</span>&lt;T&gt; event::Source <span class="kw">for </span>IoSource&lt;T&gt;
<a href=#109 id=109 data-nosnippet>109</a><span class="kw">where
<a href=#110 id=110 data-nosnippet>110</a> </span>T: AsRawFd,
<a href=#111 id=111 data-nosnippet>111</a>{
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">fn </span>register(
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#114 id=114 data-nosnippet>114</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#115 id=115 data-nosnippet>115</a> token: Token,
<a href=#116 id=116 data-nosnippet>116</a> interests: Interest,
<a href=#117 id=117 data-nosnippet>117</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#118 id=118 data-nosnippet>118</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#119 id=119 data-nosnippet>119</a> </span><span class="self">self</span>.selector_id.associate(registry)<span class="question-mark">?</span>;
<a href=#120 id=120 data-nosnippet>120</a> <span class="self">self</span>.state
<a href=#121 id=121 data-nosnippet>121</a> .register(registry, token, interests, <span class="self">self</span>.inner.as_raw_fd())
<a href=#122 id=122 data-nosnippet>122</a> }
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">fn </span>reregister(
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#126 id=126 data-nosnippet>126</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#127 id=127 data-nosnippet>127</a> token: Token,
<a href=#128 id=128 data-nosnippet>128</a> interests: Interest,
<a href=#129 id=129 data-nosnippet>129</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#130 id=130 data-nosnippet>130</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#131 id=131 data-nosnippet>131</a> </span><span class="self">self</span>.selector_id.check_association(registry)<span class="question-mark">?</span>;
<a href=#132 id=132 data-nosnippet>132</a> <span class="self">self</span>.state
<a href=#133 id=133 data-nosnippet>133</a> .reregister(registry, token, interests, <span class="self">self</span>.inner.as_raw_fd())
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#137 id=137 data-nosnippet>137</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#138 id=138 data-nosnippet>138</a> </span><span class="self">self</span>.selector_id.remove_association(registry)<span class="question-mark">?</span>;
<a href=#139 id=139 data-nosnippet>139</a> <span class="self">self</span>.state.deregister(registry, <span class="self">self</span>.inner.as_raw_fd())
<a href=#140 id=140 data-nosnippet>140</a> }
<a href=#141 id=141 data-nosnippet>141</a>}
<a href=#142 id=142 data-nosnippet>142</a>
<a href=#143 id=143 data-nosnippet>143</a><span class="attr">#[cfg(windows)]
<a href=#144 id=144 data-nosnippet>144</a></span><span class="kw">impl</span>&lt;T&gt; event::Source <span class="kw">for </span>IoSource&lt;T&gt;
<a href=#145 id=145 data-nosnippet>145</a><span class="kw">where
<a href=#146 id=146 data-nosnippet>146</a> </span>T: AsRawSocket,
<a href=#147 id=147 data-nosnippet>147</a>{
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">fn </span>register(
<a href=#149 id=149 data-nosnippet>149</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#150 id=150 data-nosnippet>150</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#151 id=151 data-nosnippet>151</a> token: Token,
<a href=#152 id=152 data-nosnippet>152</a> interests: Interest,
<a href=#153 id=153 data-nosnippet>153</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#154 id=154 data-nosnippet>154</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#155 id=155 data-nosnippet>155</a> </span><span class="self">self</span>.selector_id.associate(registry)<span class="question-mark">?</span>;
<a href=#156 id=156 data-nosnippet>156</a> <span class="self">self</span>.state
<a href=#157 id=157 data-nosnippet>157</a> .register(registry, token, interests, <span class="self">self</span>.inner.as_raw_socket())
<a href=#158 id=158 data-nosnippet>158</a> }
<a href=#159 id=159 data-nosnippet>159</a>
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">fn </span>reregister(
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#162 id=162 data-nosnippet>162</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#163 id=163 data-nosnippet>163</a> token: Token,
<a href=#164 id=164 data-nosnippet>164</a> interests: Interest,
<a href=#165 id=165 data-nosnippet>165</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#166 id=166 data-nosnippet>166</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#167 id=167 data-nosnippet>167</a> </span><span class="self">self</span>.selector_id.check_association(registry)<span class="question-mark">?</span>;
<a href=#168 id=168 data-nosnippet>168</a> <span class="self">self</span>.state.reregister(registry, token, interests)
<a href=#169 id=169 data-nosnippet>169</a> }
<a href=#170 id=170 data-nosnippet>170</a>
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, _registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#172 id=172 data-nosnippet>172</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#173 id=173 data-nosnippet>173</a> </span><span class="self">self</span>.selector_id.remove_association(_registry)<span class="question-mark">?</span>;
<a href=#174 id=174 data-nosnippet>174</a> <span class="self">self</span>.state.deregister()
<a href=#175 id=175 data-nosnippet>175</a> }
<a href=#176 id=176 data-nosnippet>176</a>}
<a href=#177 id=177 data-nosnippet>177</a>
<a href=#178 id=178 data-nosnippet>178</a><span class="attr">#[cfg(target_os = <span class="string">"wasi"</span>)]
<a href=#179 id=179 data-nosnippet>179</a></span><span class="kw">impl</span>&lt;T&gt; event::Source <span class="kw">for </span>IoSource&lt;T&gt;
<a href=#180 id=180 data-nosnippet>180</a><span class="kw">where
<a href=#181 id=181 data-nosnippet>181</a> </span>T: AsRawFd,
<a href=#182 id=182 data-nosnippet>182</a>{
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">fn </span>register(
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#185 id=185 data-nosnippet>185</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#186 id=186 data-nosnippet>186</a> token: Token,
<a href=#187 id=187 data-nosnippet>187</a> interests: Interest,
<a href=#188 id=188 data-nosnippet>188</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#189 id=189 data-nosnippet>189</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#190 id=190 data-nosnippet>190</a> </span><span class="self">self</span>.selector_id.associate(registry)<span class="question-mark">?</span>;
<a href=#191 id=191 data-nosnippet>191</a> registry
<a href=#192 id=192 data-nosnippet>192</a> .selector()
<a href=#193 id=193 data-nosnippet>193</a> .register(<span class="self">self</span>.inner.as_raw_fd() <span class="kw">as _</span>, token, interests)
<a href=#194 id=194 data-nosnippet>194</a> }
<a href=#195 id=195 data-nosnippet>195</a>
<a href=#196 id=196 data-nosnippet>196</a> <span class="kw">fn </span>reregister(
<a href=#197 id=197 data-nosnippet>197</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#198 id=198 data-nosnippet>198</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#199 id=199 data-nosnippet>199</a> token: Token,
<a href=#200 id=200 data-nosnippet>200</a> interests: Interest,
<a href=#201 id=201 data-nosnippet>201</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#202 id=202 data-nosnippet>202</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#203 id=203 data-nosnippet>203</a> </span><span class="self">self</span>.selector_id.check_association(registry)<span class="question-mark">?</span>;
<a href=#204 id=204 data-nosnippet>204</a> registry
<a href=#205 id=205 data-nosnippet>205</a> .selector()
<a href=#206 id=206 data-nosnippet>206</a> .reregister(<span class="self">self</span>.inner.as_raw_fd() <span class="kw">as _</span>, token, interests)
<a href=#207 id=207 data-nosnippet>207</a> }
<a href=#208 id=208 data-nosnippet>208</a>
<a href=#209 id=209 data-nosnippet>209</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#210 id=210 data-nosnippet>210</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#211 id=211 data-nosnippet>211</a> </span><span class="self">self</span>.selector_id.remove_association(registry)<span class="question-mark">?</span>;
<a href=#212 id=212 data-nosnippet>212</a> registry.selector().deregister(<span class="self">self</span>.inner.as_raw_fd() <span class="kw">as _</span>)
<a href=#213 id=213 data-nosnippet>213</a> }
<a href=#214 id=214 data-nosnippet>214</a>}
<a href=#215 id=215 data-nosnippet>215</a>
<a href=#216 id=216 data-nosnippet>216</a><span class="kw">impl</span>&lt;T&gt; fmt::Debug <span class="kw">for </span>IoSource&lt;T&gt;
<a href=#217 id=217 data-nosnippet>217</a><span class="kw">where
<a href=#218 id=218 data-nosnippet>218</a> </span>T: fmt::Debug,
<a href=#219 id=219 data-nosnippet>219</a>{
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#221 id=221 data-nosnippet>221</a> <span class="self">self</span>.inner.fmt(f)
<a href=#222 id=222 data-nosnippet>222</a> }
<a href=#223 id=223 data-nosnippet>223</a>}
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a><span class="doccomment">/// Used to associate an `IoSource` with a `sys::Selector`.
<a href=#226 id=226 data-nosnippet>226</a></span><span class="attr">#[cfg(debug_assertions)]
<a href=#227 id=227 data-nosnippet>227</a>#[derive(Debug)]
<a href=#228 id=228 data-nosnippet>228</a></span><span class="kw">struct </span>SelectorId {
<a href=#229 id=229 data-nosnippet>229</a> id: AtomicUsize,
<a href=#230 id=230 data-nosnippet>230</a>}
<a href=#231 id=231 data-nosnippet>231</a>
<a href=#232 id=232 data-nosnippet>232</a><span class="attr">#[cfg(debug_assertions)]
<a href=#233 id=233 data-nosnippet>233</a></span><span class="kw">impl </span>SelectorId {
<a href=#234 id=234 data-nosnippet>234</a> <span class="doccomment">/// Value of `id` if `SelectorId` is not associated with any
<a href=#235 id=235 data-nosnippet>235</a> /// `sys::Selector`. Valid selector ids start at 1.
<a href=#236 id=236 data-nosnippet>236</a> </span><span class="kw">const </span>UNASSOCIATED: usize = <span class="number">0</span>;
<a href=#237 id=237 data-nosnippet>237</a>
<a href=#238 id=238 data-nosnippet>238</a> <span class="doccomment">/// Create a new `SelectorId`.
<a href=#239 id=239 data-nosnippet>239</a> </span><span class="kw">const fn </span>new() -&gt; SelectorId {
<a href=#240 id=240 data-nosnippet>240</a> SelectorId {
<a href=#241 id=241 data-nosnippet>241</a> id: AtomicUsize::new(<span class="self">Self</span>::UNASSOCIATED),
<a href=#242 id=242 data-nosnippet>242</a> }
<a href=#243 id=243 data-nosnippet>243</a> }
<a href=#244 id=244 data-nosnippet>244</a>
<a href=#245 id=245 data-nosnippet>245</a> <span class="doccomment">/// Associate an I/O source with `registry`, returning an error if its
<a href=#246 id=246 data-nosnippet>246</a> /// already registered.
<a href=#247 id=247 data-nosnippet>247</a> </span><span class="kw">fn </span>associate(<span class="kw-2">&amp;</span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#248 id=248 data-nosnippet>248</a> <span class="kw">let </span>registry_id = registry.selector().id();
<a href=#249 id=249 data-nosnippet>249</a> <span class="kw">let </span>previous_id = <span class="self">self</span>.id.swap(registry_id, Ordering::AcqRel);
<a href=#250 id=250 data-nosnippet>250</a>
<a href=#251 id=251 data-nosnippet>251</a> <span class="kw">if </span>previous_id == <span class="self">Self</span>::UNASSOCIATED {
<a href=#252 id=252 data-nosnippet>252</a> <span class="prelude-val">Ok</span>(())
<a href=#253 id=253 data-nosnippet>253</a> } <span class="kw">else </span>{
<a href=#254 id=254 data-nosnippet>254</a> <span class="prelude-val">Err</span>(io::Error::new(
<a href=#255 id=255 data-nosnippet>255</a> io::ErrorKind::AlreadyExists,
<a href=#256 id=256 data-nosnippet>256</a> <span class="string">"I/O source already registered with a `Registry`"</span>,
<a href=#257 id=257 data-nosnippet>257</a> ))
<a href=#258 id=258 data-nosnippet>258</a> }
<a href=#259 id=259 data-nosnippet>259</a> }
<a href=#260 id=260 data-nosnippet>260</a>
<a href=#261 id=261 data-nosnippet>261</a> <span class="doccomment">/// Check the association of an I/O source with `registry`, returning an
<a href=#262 id=262 data-nosnippet>262</a> /// error if its registered with a different `Registry` or not registered at
<a href=#263 id=263 data-nosnippet>263</a> /// all.
<a href=#264 id=264 data-nosnippet>264</a> </span><span class="kw">fn </span>check_association(<span class="kw-2">&amp;</span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#265 id=265 data-nosnippet>265</a> <span class="kw">let </span>registry_id = registry.selector().id();
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">let </span>id = <span class="self">self</span>.id.load(Ordering::Acquire);
<a href=#267 id=267 data-nosnippet>267</a>
<a href=#268 id=268 data-nosnippet>268</a> <span class="kw">if </span>id == registry_id {
<a href=#269 id=269 data-nosnippet>269</a> <span class="prelude-val">Ok</span>(())
<a href=#270 id=270 data-nosnippet>270</a> } <span class="kw">else if </span>id == <span class="self">Self</span>::UNASSOCIATED {
<a href=#271 id=271 data-nosnippet>271</a> <span class="prelude-val">Err</span>(io::Error::new(
<a href=#272 id=272 data-nosnippet>272</a> io::ErrorKind::NotFound,
<a href=#273 id=273 data-nosnippet>273</a> <span class="string">"I/O source not registered with `Registry`"</span>,
<a href=#274 id=274 data-nosnippet>274</a> ))
<a href=#275 id=275 data-nosnippet>275</a> } <span class="kw">else </span>{
<a href=#276 id=276 data-nosnippet>276</a> <span class="prelude-val">Err</span>(io::Error::new(
<a href=#277 id=277 data-nosnippet>277</a> io::ErrorKind::AlreadyExists,
<a href=#278 id=278 data-nosnippet>278</a> <span class="string">"I/O source already registered with a different `Registry`"</span>,
<a href=#279 id=279 data-nosnippet>279</a> ))
<a href=#280 id=280 data-nosnippet>280</a> }
<a href=#281 id=281 data-nosnippet>281</a> }
<a href=#282 id=282 data-nosnippet>282</a>
<a href=#283 id=283 data-nosnippet>283</a> <span class="doccomment">/// Remove a previously made association from `registry`, returns an error
<a href=#284 id=284 data-nosnippet>284</a> /// if it was not previously associated with `registry`.
<a href=#285 id=285 data-nosnippet>285</a> </span><span class="kw">fn </span>remove_association(<span class="kw-2">&amp;</span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#286 id=286 data-nosnippet>286</a> <span class="kw">let </span>registry_id = registry.selector().id();
<a href=#287 id=287 data-nosnippet>287</a> <span class="kw">let </span>previous_id = <span class="self">self</span>.id.swap(<span class="self">Self</span>::UNASSOCIATED, Ordering::AcqRel);
<a href=#288 id=288 data-nosnippet>288</a>
<a href=#289 id=289 data-nosnippet>289</a> <span class="kw">if </span>previous_id == registry_id {
<a href=#290 id=290 data-nosnippet>290</a> <span class="prelude-val">Ok</span>(())
<a href=#291 id=291 data-nosnippet>291</a> } <span class="kw">else </span>{
<a href=#292 id=292 data-nosnippet>292</a> <span class="prelude-val">Err</span>(io::Error::new(
<a href=#293 id=293 data-nosnippet>293</a> io::ErrorKind::NotFound,
<a href=#294 id=294 data-nosnippet>294</a> <span class="string">"I/O source not registered with `Registry`"</span>,
<a href=#295 id=295 data-nosnippet>295</a> ))
<a href=#296 id=296 data-nosnippet>296</a> }
<a href=#297 id=297 data-nosnippet>297</a> }
<a href=#298 id=298 data-nosnippet>298</a>}
<a href=#299 id=299 data-nosnippet>299</a>
<a href=#300 id=300 data-nosnippet>300</a><span class="attr">#[cfg(debug_assertions)]
<a href=#301 id=301 data-nosnippet>301</a></span><span class="kw">impl </span>Clone <span class="kw">for </span>SelectorId {
<a href=#302 id=302 data-nosnippet>302</a> <span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; SelectorId {
<a href=#303 id=303 data-nosnippet>303</a> SelectorId {
<a href=#304 id=304 data-nosnippet>304</a> id: AtomicUsize::new(<span class="self">self</span>.id.load(Ordering::Acquire)),
<a href=#305 id=305 data-nosnippet>305</a> }
<a href=#306 id=306 data-nosnippet>306</a> }
<a href=#307 id=307 data-nosnippet>307</a>}
</code></pre></div></section></main></body></html>
+278
View File
@@ -0,0 +1,278 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="attr">#![deny(
<a href=#2 id=2 data-nosnippet>2</a> missing_docs,
<a href=#3 id=3 data-nosnippet>3</a> missing_debug_implementations,
<a href=#4 id=4 data-nosnippet>4</a> rust_2018_idioms,
<a href=#5 id=5 data-nosnippet>5</a> unused_imports,
<a href=#6 id=6 data-nosnippet>6</a> dead_code
<a href=#7 id=7 data-nosnippet>7</a>)]
<a href=#8 id=8 data-nosnippet>8</a>#![cfg_attr(docsrs, feature(doc_cfg))]
<a href=#9 id=9 data-nosnippet>9</a></span><span class="comment">// Disallow warnings when running tests.
<a href=#10 id=10 data-nosnippet>10</a></span><span class="attr">#![cfg_attr(test, deny(warnings))]
<a href=#11 id=11 data-nosnippet>11</a></span><span class="comment">// Disallow warnings in examples.
<a href=#12 id=12 data-nosnippet>12</a></span><span class="attr">#![doc(test(attr(deny(warnings))))]
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a></span><span class="doccomment">//! Mio is a fast, low-level I/O library for Rust focusing on non-blocking APIs
<a href=#15 id=15 data-nosnippet>15</a>//! and event notification for building high performance I/O apps with as little
<a href=#16 id=16 data-nosnippet>16</a>//! overhead as possible over the OS abstractions.
<a href=#17 id=17 data-nosnippet>17</a>//!
<a href=#18 id=18 data-nosnippet>18</a>//! # Usage
<a href=#19 id=19 data-nosnippet>19</a>//!
<a href=#20 id=20 data-nosnippet>20</a>//! Using Mio starts by creating a [`Poll`], which reads events from the OS and
<a href=#21 id=21 data-nosnippet>21</a>//! puts them into [`Events`]. You can handle I/O events from the OS with it.
<a href=#22 id=22 data-nosnippet>22</a>//!
<a href=#23 id=23 data-nosnippet>23</a>//! For more detail, see [`Poll`].
<a href=#24 id=24 data-nosnippet>24</a>//!
<a href=#25 id=25 data-nosnippet>25</a>//! [`Poll`]: ../mio/struct.Poll.html
<a href=#26 id=26 data-nosnippet>26</a>//! [`Events`]: ../mio/event/struct.Events.html
<a href=#27 id=27 data-nosnippet>27</a>//!
<a href=#28 id=28 data-nosnippet>28</a>//! ## Examples
<a href=#29 id=29 data-nosnippet>29</a>//!
<a href=#30 id=30 data-nosnippet>30</a>//! Examples can be found in the `examples` directory of the source code, or [on
<a href=#31 id=31 data-nosnippet>31</a>//! GitHub].
<a href=#32 id=32 data-nosnippet>32</a>//!
<a href=#33 id=33 data-nosnippet>33</a>//! [on GitHub]: https://github.com/tokio-rs/mio/tree/master/examples
<a href=#34 id=34 data-nosnippet>34</a>//!
<a href=#35 id=35 data-nosnippet>35</a>//! ## Guide
<a href=#36 id=36 data-nosnippet>36</a>//!
<a href=#37 id=37 data-nosnippet>37</a>//! A getting started guide is available in the [`guide`] module.
<a href=#38 id=38 data-nosnippet>38</a>//!
<a href=#39 id=39 data-nosnippet>39</a>//! ## Available features
<a href=#40 id=40 data-nosnippet>40</a>//!
<a href=#41 id=41 data-nosnippet>41</a>//! The available features are described in the [`features`] module.
<a href=#42 id=42 data-nosnippet>42</a>
<a href=#43 id=43 data-nosnippet>43</a></span><span class="attr">#[cfg(all(target_family = <span class="string">"wasm"</span>, not(target_os = <span class="string">"wasi"</span>)))]
<a href=#44 id=44 data-nosnippet>44</a></span><span class="macro">compile_error!</span>(<span class="string">"This wasm target is unsupported by mio. If using Tokio, disable the net feature."</span>);
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a><span class="comment">// macros used internally
<a href=#47 id=47 data-nosnippet>47</a></span><span class="attr">#[macro_use]
<a href=#48 id=48 data-nosnippet>48</a></span><span class="kw">mod </span>macros;
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a><span class="kw">mod </span>interest;
<a href=#51 id=51 data-nosnippet>51</a><span class="kw">mod </span>poll;
<a href=#52 id=52 data-nosnippet>52</a><span class="kw">mod </span>sys;
<a href=#53 id=53 data-nosnippet>53</a><span class="kw">mod </span>token;
<a href=#54 id=54 data-nosnippet>54</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#55 id=55 data-nosnippet>55</a></span><span class="kw">mod </span>waker;
<a href=#56 id=56 data-nosnippet>56</a>
<a href=#57 id=57 data-nosnippet>57</a><span class="kw">pub mod </span>event;
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a><span class="macro">cfg_io_source!</span> {
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">mod </span>io_source;
<a href=#61 id=61 data-nosnippet>61</a>}
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a><span class="macro">cfg_net!</span> {
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">pub mod </span>net;
<a href=#65 id=65 data-nosnippet>65</a>}
<a href=#66 id=66 data-nosnippet>66</a>
<a href=#67 id=67 data-nosnippet>67</a><span class="attr">#[doc(no_inline)]
<a href=#68 id=68 data-nosnippet>68</a></span><span class="kw">pub use </span>event::Events;
<a href=#69 id=69 data-nosnippet>69</a><span class="kw">pub use </span>interest::Interest;
<a href=#70 id=70 data-nosnippet>70</a><span class="kw">pub use </span>poll::{Poll, Registry};
<a href=#71 id=71 data-nosnippet>71</a><span class="kw">pub use </span>token::Token;
<a href=#72 id=72 data-nosnippet>72</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#73 id=73 data-nosnippet>73</a></span><span class="kw">pub use </span>waker::Waker;
<a href=#74 id=74 data-nosnippet>74</a>
<a href=#75 id=75 data-nosnippet>75</a><span class="attr">#[cfg(all(unix, feature = <span class="string">"os-ext"</span>))]
<a href=#76 id=76 data-nosnippet>76</a>#[cfg_attr(docsrs, doc(cfg(all(unix, feature = <span class="string">"os-ext"</span>))))]
<a href=#77 id=77 data-nosnippet>77</a></span><span class="kw">pub mod </span>unix {
<a href=#78 id=78 data-nosnippet>78</a> <span class="doccomment">//! Unix only extensions.
<a href=#79 id=79 data-nosnippet>79</a>
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">pub mod </span>pipe {
<a href=#81 id=81 data-nosnippet>81</a> <span class="doccomment">//! Unix pipe.
<a href=#82 id=82 data-nosnippet>82</a> //!
<a href=#83 id=83 data-nosnippet>83</a> //! See the [`new`] function for documentation.
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::pipe::{new, Receiver, Sender};
<a href=#86 id=86 data-nosnippet>86</a> }
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">pub use </span><span class="kw">crate</span>::sys::SourceFd;
<a href=#89 id=89 data-nosnippet>89</a>}
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a><span class="attr">#[cfg(all(target_os = <span class="string">"hermit"</span>, feature = <span class="string">"os-ext"</span>))]
<a href=#92 id=92 data-nosnippet>92</a>#[cfg_attr(docsrs, doc(cfg(all(target_os = <span class="string">"hermit"</span>, feature = <span class="string">"os-ext"</span>))))]
<a href=#93 id=93 data-nosnippet>93</a></span><span class="kw">pub mod </span>hermit {
<a href=#94 id=94 data-nosnippet>94</a> <span class="doccomment">//! Hermit only extensions.
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a> </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::SourceFd;
<a href=#97 id=97 data-nosnippet>97</a>}
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a><span class="attr">#[cfg(all(windows, feature = <span class="string">"os-ext"</span>))]
<a href=#100 id=100 data-nosnippet>100</a>#[cfg_attr(docsrs, doc(cfg(all(windows, feature = <span class="string">"os-ext"</span>))))]
<a href=#101 id=101 data-nosnippet>101</a></span><span class="kw">pub mod </span>windows {
<a href=#102 id=102 data-nosnippet>102</a> <span class="doccomment">//! Windows only extensions.
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> </span><span class="kw">pub use </span><span class="kw">crate</span>::sys::named_pipe::NamedPipe;
<a href=#105 id=105 data-nosnippet>105</a>}
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a><span class="kw">pub mod </span>features {
<a href=#108 id=108 data-nosnippet>108</a> <span class="doccomment">//! # Mio's optional features.
<a href=#109 id=109 data-nosnippet>109</a> //!
<a href=#110 id=110 data-nosnippet>110</a> //! This document describes the available features in Mio.
<a href=#111 id=111 data-nosnippet>111</a> //!
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"## `os-poll` (enabled)"</span>)]
<a href=#113 id=113 data-nosnippet>113</a> #![cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"## `os-poll` (disabled)"</span>)]
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="doccomment">//!
<a href=#115 id=115 data-nosnippet>115</a> //! Mio by default provides only a shell implementation that `panic!`s the
<a href=#116 id=116 data-nosnippet>116</a> //! moment it is actually run. To run it requires OS support, this is
<a href=#117 id=117 data-nosnippet>117</a> //! enabled by activating the `os-poll` feature.
<a href=#118 id=118 data-nosnippet>118</a> //!
<a href=#119 id=119 data-nosnippet>119</a> //! This makes `Poll`, `Registry` and `Waker` functional.
<a href=#120 id=120 data-nosnippet>120</a> //!
<a href=#121 id=121 data-nosnippet>121</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"os-ext"</span>, doc = <span class="string">"## `os-ext` (enabled)"</span>)]
<a href=#122 id=122 data-nosnippet>122</a> #![cfg_attr(not(feature = <span class="string">"os-ext"</span>), doc = <span class="string">"## `os-ext` (disabled)"</span>)]
<a href=#123 id=123 data-nosnippet>123</a> </span><span class="doccomment">//!
<a href=#124 id=124 data-nosnippet>124</a> //! `os-ext` enables additional OS specific facilities. These facilities can
<a href=#125 id=125 data-nosnippet>125</a> //! be found in the `unix` and `windows` module.
<a href=#126 id=126 data-nosnippet>126</a> //!
<a href=#127 id=127 data-nosnippet>127</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"net"</span>, doc = <span class="string">"## Network types (enabled)"</span>)]
<a href=#128 id=128 data-nosnippet>128</a> #![cfg_attr(not(feature = <span class="string">"net"</span>), doc = <span class="string">"## Network types (disabled)"</span>)]
<a href=#129 id=129 data-nosnippet>129</a> </span><span class="doccomment">//!
<a href=#130 id=130 data-nosnippet>130</a> //! The `net` feature enables networking primitives in the `net` module.
<a href=#131 id=131 data-nosnippet>131</a></span>}
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a><span class="kw">pub mod </span>guide {
<a href=#134 id=134 data-nosnippet>134</a> <span class="doccomment">//! # Getting started guide.
<a href=#135 id=135 data-nosnippet>135</a> //!
<a href=#136 id=136 data-nosnippet>136</a> //! In this guide we'll do the following:
<a href=#137 id=137 data-nosnippet>137</a> //!
<a href=#138 id=138 data-nosnippet>138</a> //! 1. Create a [`Poll`] instance (and learn what it is).
<a href=#139 id=139 data-nosnippet>139</a> //! 2. Register an [event source].
<a href=#140 id=140 data-nosnippet>140</a> //! 3. Create an event loop.
<a href=#141 id=141 data-nosnippet>141</a> //!
<a href=#142 id=142 data-nosnippet>142</a> //! At the end you'll have a very small (but quick) TCP server that accepts
<a href=#143 id=143 data-nosnippet>143</a> //! connections and then drops (disconnects) them.
<a href=#144 id=144 data-nosnippet>144</a> //!
<a href=#145 id=145 data-nosnippet>145</a> //! ## 1. Creating a `Poll` instance
<a href=#146 id=146 data-nosnippet>146</a> //!
<a href=#147 id=147 data-nosnippet>147</a> //! Using Mio starts by creating a [`Poll`] instance, which monitors events
<a href=#148 id=148 data-nosnippet>148</a> //! from the OS and puts them into [`Events`]. This allows us to execute I/O
<a href=#149 id=149 data-nosnippet>149</a> //! operations based on what operations are ready.
<a href=#150 id=150 data-nosnippet>150</a> //!
<a href=#151 id=151 data-nosnippet>151</a> //! [`Poll`]: ../struct.Poll.html
<a href=#152 id=152 data-nosnippet>152</a> //! [`Events`]: ../event/struct.Events.html
<a href=#153 id=153 data-nosnippet>153</a> //!
<a href=#154 id=154 data-nosnippet>154</a> </span><span class="attr">#![cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#155 id=155 data-nosnippet>155</a> #![cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#156 id=156 data-nosnippet>156</a> </span><span class="doccomment">//! # use mio::{Poll, Events};
<a href=#157 id=157 data-nosnippet>157</a> //! # fn main() -&gt; std::io::Result&lt;()&gt; {
<a href=#158 id=158 data-nosnippet>158</a> //! // `Poll` allows for polling of readiness events.
<a href=#159 id=159 data-nosnippet>159</a> //! let poll = Poll::new()?;
<a href=#160 id=160 data-nosnippet>160</a> //! // `Events` is collection of readiness `Event`s and can be filled by
<a href=#161 id=161 data-nosnippet>161</a> //! // calling `Poll::poll`.
<a href=#162 id=162 data-nosnippet>162</a> //! let events = Events::with_capacity(128);
<a href=#163 id=163 data-nosnippet>163</a> //! # drop((poll, events));
<a href=#164 id=164 data-nosnippet>164</a> //! # Ok(())
<a href=#165 id=165 data-nosnippet>165</a> //! # }
<a href=#166 id=166 data-nosnippet>166</a> //! ```
<a href=#167 id=167 data-nosnippet>167</a> //!
<a href=#168 id=168 data-nosnippet>168</a> //! For example if we're using a [`TcpListener`], we'll only want to
<a href=#169 id=169 data-nosnippet>169</a> //! attempt to accept an incoming connection *iff* any connections are
<a href=#170 id=170 data-nosnippet>170</a> //! queued and ready to be accepted. We don't want to waste our time if no
<a href=#171 id=171 data-nosnippet>171</a> //! connections are ready.
<a href=#172 id=172 data-nosnippet>172</a> //!
<a href=#173 id=173 data-nosnippet>173</a> //! [`TcpListener`]: ../net/struct.TcpListener.html
<a href=#174 id=174 data-nosnippet>174</a> //!
<a href=#175 id=175 data-nosnippet>175</a> //! ## 2. Registering event source
<a href=#176 id=176 data-nosnippet>176</a> //!
<a href=#177 id=177 data-nosnippet>177</a> //! After we've created a [`Poll`] instance that monitors events from the OS
<a href=#178 id=178 data-nosnippet>178</a> //! for us, we need to provide it with a source of events. This is done by
<a href=#179 id=179 data-nosnippet>179</a> //! registering an [event source]. As the name “event source” suggests it is
<a href=#180 id=180 data-nosnippet>180</a> //! a source of events which can be polled using a `Poll` instance. On Unix
<a href=#181 id=181 data-nosnippet>181</a> //! systems this is usually a file descriptor, or a socket/handle on
<a href=#182 id=182 data-nosnippet>182</a> //! Windows.
<a href=#183 id=183 data-nosnippet>183</a> //!
<a href=#184 id=184 data-nosnippet>184</a> //! In the example below we'll use a [`TcpListener`] for which we'll receive
<a href=#185 id=185 data-nosnippet>185</a> //! an event (from [`Poll`]) once a connection is ready to be accepted.
<a href=#186 id=186 data-nosnippet>186</a> //!
<a href=#187 id=187 data-nosnippet>187</a> //! [event source]: ../event/trait.Source.html
<a href=#188 id=188 data-nosnippet>188</a> //!
<a href=#189 id=189 data-nosnippet>189</a> </span><span class="attr">#![cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#190 id=190 data-nosnippet>190</a> #![cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#191 id=191 data-nosnippet>191</a> </span><span class="doccomment">//! # use mio::net::TcpListener;
<a href=#192 id=192 data-nosnippet>192</a> //! # use mio::{Poll, Token, Interest};
<a href=#193 id=193 data-nosnippet>193</a> //! # fn main() -&gt; std::io::Result&lt;()&gt; {
<a href=#194 id=194 data-nosnippet>194</a> //! # let poll = Poll::new()?;
<a href=#195 id=195 data-nosnippet>195</a> //! # let address = "127.0.0.1:0".parse().unwrap();
<a href=#196 id=196 data-nosnippet>196</a> //! // Create a `TcpListener`, binding it to `address`.
<a href=#197 id=197 data-nosnippet>197</a> //! let mut listener = TcpListener::bind(address)?;
<a href=#198 id=198 data-nosnippet>198</a> //!
<a href=#199 id=199 data-nosnippet>199</a> //! // Next we register it with `Poll` to receive events for it. The `SERVER`
<a href=#200 id=200 data-nosnippet>200</a> //! // `Token` is used to determine that we received an event for the listener
<a href=#201 id=201 data-nosnippet>201</a> //! // later on.
<a href=#202 id=202 data-nosnippet>202</a> //! const SERVER: Token = Token(0);
<a href=#203 id=203 data-nosnippet>203</a> //! poll.registry().register(&amp;mut listener, SERVER, Interest::READABLE)?;
<a href=#204 id=204 data-nosnippet>204</a> //! # Ok(())
<a href=#205 id=205 data-nosnippet>205</a> //! # }
<a href=#206 id=206 data-nosnippet>206</a> //! ```
<a href=#207 id=207 data-nosnippet>207</a> //!
<a href=#208 id=208 data-nosnippet>208</a> //! Multiple event sources can be [registered] (concurrently), so we can
<a href=#209 id=209 data-nosnippet>209</a> //! monitor multiple sources at a time.
<a href=#210 id=210 data-nosnippet>210</a> //!
<a href=#211 id=211 data-nosnippet>211</a> //! [registered]: ../struct.Registry.html#method.register
<a href=#212 id=212 data-nosnippet>212</a> //!
<a href=#213 id=213 data-nosnippet>213</a> //! ## 3. Creating the event loop
<a href=#214 id=214 data-nosnippet>214</a> //!
<a href=#215 id=215 data-nosnippet>215</a> //! After we've created a [`Poll`] instance and registered one or more
<a href=#216 id=216 data-nosnippet>216</a> //! [event sources] with it, we can [poll] it for events. Polling for events
<a href=#217 id=217 data-nosnippet>217</a> //! is simple, we need a container to store the events: [`Events`] and need
<a href=#218 id=218 data-nosnippet>218</a> //! to do something based on the polled events (this part is up to you, we
<a href=#219 id=219 data-nosnippet>219</a> //! can't do it all!). If we do this in a loop we've got ourselves an event
<a href=#220 id=220 data-nosnippet>220</a> //! loop.
<a href=#221 id=221 data-nosnippet>221</a> //!
<a href=#222 id=222 data-nosnippet>222</a> //! The example below shows the event loop in action, completing our small
<a href=#223 id=223 data-nosnippet>223</a> //! TCP server.
<a href=#224 id=224 data-nosnippet>224</a> //!
<a href=#225 id=225 data-nosnippet>225</a> //! [poll]: ../struct.Poll.html#method.poll
<a href=#226 id=226 data-nosnippet>226</a> //! [event sources]: ../event/trait.Source.html
<a href=#227 id=227 data-nosnippet>227</a> //!
<a href=#228 id=228 data-nosnippet>228</a> </span><span class="attr">#![cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#229 id=229 data-nosnippet>229</a> #![cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#230 id=230 data-nosnippet>230</a> </span><span class="doccomment">//! # use std::io;
<a href=#231 id=231 data-nosnippet>231</a> //! # use std::time::Duration;
<a href=#232 id=232 data-nosnippet>232</a> //! # use mio::net::TcpListener;
<a href=#233 id=233 data-nosnippet>233</a> //! # use mio::{Poll, Token, Interest, Events};
<a href=#234 id=234 data-nosnippet>234</a> //! # fn main() -&gt; io::Result&lt;()&gt; {
<a href=#235 id=235 data-nosnippet>235</a> //! # let mut poll = Poll::new()?;
<a href=#236 id=236 data-nosnippet>236</a> //! # let mut events = Events::with_capacity(128);
<a href=#237 id=237 data-nosnippet>237</a> //! # let address = "127.0.0.1:0".parse().unwrap();
<a href=#238 id=238 data-nosnippet>238</a> //! # let mut listener = TcpListener::bind(address)?;
<a href=#239 id=239 data-nosnippet>239</a> //! # const SERVER: Token = Token(0);
<a href=#240 id=240 data-nosnippet>240</a> //! # poll.registry().register(&amp;mut listener, SERVER, Interest::READABLE)?;
<a href=#241 id=241 data-nosnippet>241</a> //! // Start our event loop.
<a href=#242 id=242 data-nosnippet>242</a> //! loop {
<a href=#243 id=243 data-nosnippet>243</a> //! // Poll the OS for events, waiting at most 100 milliseconds.
<a href=#244 id=244 data-nosnippet>244</a> //! poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#245 id=245 data-nosnippet>245</a> //!
<a href=#246 id=246 data-nosnippet>246</a> //! // Process each event.
<a href=#247 id=247 data-nosnippet>247</a> //! for event in events.iter() {
<a href=#248 id=248 data-nosnippet>248</a> //! // We can use the token we previously provided to `register` to
<a href=#249 id=249 data-nosnippet>249</a> //! // determine for which type the event is.
<a href=#250 id=250 data-nosnippet>250</a> //! match event.token() {
<a href=#251 id=251 data-nosnippet>251</a> //! SERVER =&gt; loop {
<a href=#252 id=252 data-nosnippet>252</a> //! // One or more connections are ready, so we'll attempt to
<a href=#253 id=253 data-nosnippet>253</a> //! // accept them (in a loop).
<a href=#254 id=254 data-nosnippet>254</a> //! match listener.accept() {
<a href=#255 id=255 data-nosnippet>255</a> //! Ok((connection, address)) =&gt; {
<a href=#256 id=256 data-nosnippet>256</a> //! println!("Got a connection from: {}", address);
<a href=#257 id=257 data-nosnippet>257</a> //! # drop(connection);
<a href=#258 id=258 data-nosnippet>258</a> //! },
<a href=#259 id=259 data-nosnippet>259</a> //! // A "would block error" is returned if the operation
<a href=#260 id=260 data-nosnippet>260</a> //! // is not ready, so we'll stop trying to accept
<a href=#261 id=261 data-nosnippet>261</a> //! // connections.
<a href=#262 id=262 data-nosnippet>262</a> //! Err(ref err) if would_block(err) =&gt; break,
<a href=#263 id=263 data-nosnippet>263</a> //! Err(err) =&gt; return Err(err),
<a href=#264 id=264 data-nosnippet>264</a> //! }
<a href=#265 id=265 data-nosnippet>265</a> //! }
<a href=#266 id=266 data-nosnippet>266</a> //! # _ =&gt; unreachable!(),
<a href=#267 id=267 data-nosnippet>267</a> //! }
<a href=#268 id=268 data-nosnippet>268</a> //! }
<a href=#269 id=269 data-nosnippet>269</a> //! # return Ok(());
<a href=#270 id=270 data-nosnippet>270</a> //! }
<a href=#271 id=271 data-nosnippet>271</a> //!
<a href=#272 id=272 data-nosnippet>272</a> //! fn would_block(err: &amp;io::Error) -&gt; bool {
<a href=#273 id=273 data-nosnippet>273</a> //! err.kind() == io::ErrorKind::WouldBlock
<a href=#274 id=274 data-nosnippet>274</a> //! }
<a href=#275 id=275 data-nosnippet>275</a> //! # }
<a href=#276 id=276 data-nosnippet>276</a> //! ```
<a href=#277 id=277 data-nosnippet>277</a></span>}
</code></pre></div></section></main></body></html>
+99
View File
@@ -0,0 +1,99 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/macros.rs`."><title>macros.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>macros.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Macros to ease conditional code based on enabled features.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="comment">// Depending on the features not all macros are used.
<a href=#4 id=4 data-nosnippet>4</a></span><span class="attr">#![allow(unused_macros)]
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a></span><span class="doccomment">/// The `os-poll` feature is enabled.
<a href=#7 id=7 data-nosnippet>7</a></span><span class="macro">macro_rules!</span> cfg_os_poll {
<a href=#8 id=8 data-nosnippet>8</a> ($(<span class="macro-nonterminal">$item</span>:item)<span class="kw-2">*</span>) =&gt; {
<a href=#9 id=9 data-nosnippet>9</a> $(
<a href=#10 id=10 data-nosnippet>10</a> <span class="attr">#[cfg(feature = <span class="string">"os-poll"</span>)]
<a href=#11 id=11 data-nosnippet>11</a> #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"os-poll"</span>)))]
<a href=#12 id=12 data-nosnippet>12</a> </span><span class="macro-nonterminal">$item
<a href=#13 id=13 data-nosnippet>13</a> </span>)*
<a href=#14 id=14 data-nosnippet>14</a> }
<a href=#15 id=15 data-nosnippet>15</a>}
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="doccomment">/// The `os-poll` feature is disabled.
<a href=#18 id=18 data-nosnippet>18</a></span><span class="macro">macro_rules!</span> cfg_not_os_poll {
<a href=#19 id=19 data-nosnippet>19</a> ($(<span class="macro-nonterminal">$item</span>:item)<span class="kw-2">*</span>) =&gt; {
<a href=#20 id=20 data-nosnippet>20</a> $(
<a href=#21 id=21 data-nosnippet>21</a> <span class="attr">#[cfg(not(feature = <span class="string">"os-poll"</span>))]
<a href=#22 id=22 data-nosnippet>22</a> </span><span class="macro-nonterminal">$item
<a href=#23 id=23 data-nosnippet>23</a> </span>)*
<a href=#24 id=24 data-nosnippet>24</a> }
<a href=#25 id=25 data-nosnippet>25</a>}
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="doccomment">/// The `os-ext` feature is enabled.
<a href=#28 id=28 data-nosnippet>28</a></span><span class="macro">macro_rules!</span> cfg_os_ext {
<a href=#29 id=29 data-nosnippet>29</a> ($(<span class="macro-nonterminal">$item</span>:item)<span class="kw-2">*</span>) =&gt; {
<a href=#30 id=30 data-nosnippet>30</a> $(
<a href=#31 id=31 data-nosnippet>31</a> <span class="attr">#[cfg(feature = <span class="string">"os-ext"</span>)]
<a href=#32 id=32 data-nosnippet>32</a> #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"os-ext"</span>)))]
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="macro-nonterminal">$item
<a href=#34 id=34 data-nosnippet>34</a> </span>)*
<a href=#35 id=35 data-nosnippet>35</a> }
<a href=#36 id=36 data-nosnippet>36</a>}
<a href=#37 id=37 data-nosnippet>37</a>
<a href=#38 id=38 data-nosnippet>38</a><span class="doccomment">/// The `net` feature is enabled.
<a href=#39 id=39 data-nosnippet>39</a></span><span class="macro">macro_rules!</span> cfg_net {
<a href=#40 id=40 data-nosnippet>40</a> ($(<span class="macro-nonterminal">$item</span>:item)<span class="kw-2">*</span>) =&gt; {
<a href=#41 id=41 data-nosnippet>41</a> $(
<a href=#42 id=42 data-nosnippet>42</a> <span class="attr">#[cfg(feature = <span class="string">"net"</span>)]
<a href=#43 id=43 data-nosnippet>43</a> #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"net"</span>)))]
<a href=#44 id=44 data-nosnippet>44</a> </span><span class="macro-nonterminal">$item
<a href=#45 id=45 data-nosnippet>45</a> </span>)*
<a href=#46 id=46 data-nosnippet>46</a> }
<a href=#47 id=47 data-nosnippet>47</a>}
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a><span class="doccomment">/// One of the features enabled that needs `IoSource`. That is `net` or `os-ext`
<a href=#50 id=50 data-nosnippet>50</a>/// on Unix (for `pipe`).
<a href=#51 id=51 data-nosnippet>51</a></span><span class="macro">macro_rules!</span> cfg_io_source {
<a href=#52 id=52 data-nosnippet>52</a> ($(<span class="macro-nonterminal">$item</span>:item)<span class="kw-2">*</span>) =&gt; {
<a href=#53 id=53 data-nosnippet>53</a> $(
<a href=#54 id=54 data-nosnippet>54</a> <span class="attr">#[cfg(any(feature = <span class="string">"net"</span>, all(unix, feature = <span class="string">"os-ext"</span>)))]
<a href=#55 id=55 data-nosnippet>55</a> #[cfg_attr(docsrs, doc(cfg(any(feature = <span class="string">"net"</span>, all(unix, feature = <span class="string">"os-ext"</span>)))))]
<a href=#56 id=56 data-nosnippet>56</a> </span><span class="macro-nonterminal">$item
<a href=#57 id=57 data-nosnippet>57</a> </span>)*
<a href=#58 id=58 data-nosnippet>58</a> }
<a href=#59 id=59 data-nosnippet>59</a>}
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a><span class="doccomment">/// The `os-ext` feature is enabled, or one of the features that need `os-ext`.
<a href=#62 id=62 data-nosnippet>62</a></span><span class="macro">macro_rules!</span> cfg_any_os_ext {
<a href=#63 id=63 data-nosnippet>63</a> ($(<span class="macro-nonterminal">$item</span>:item)<span class="kw-2">*</span>) =&gt; {
<a href=#64 id=64 data-nosnippet>64</a> $(
<a href=#65 id=65 data-nosnippet>65</a> <span class="attr">#[cfg(any(feature = <span class="string">"os-ext"</span>, feature = <span class="string">"net"</span>))]
<a href=#66 id=66 data-nosnippet>66</a> #[cfg_attr(docsrs, doc(cfg(any(feature = <span class="string">"os-ext"</span>, feature = <span class="string">"net"</span>))))]
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="macro-nonterminal">$item
<a href=#68 id=68 data-nosnippet>68</a> </span>)*
<a href=#69 id=69 data-nosnippet>69</a> }
<a href=#70 id=70 data-nosnippet>70</a>}
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a><span class="macro">macro_rules!</span> trace {
<a href=#73 id=73 data-nosnippet>73</a> ($(<span class="macro-nonterminal">$t</span>:tt)<span class="kw-2">*</span>) =&gt; {
<a href=#74 id=74 data-nosnippet>74</a> <span class="macro">log!</span>(trace, $(<span class="macro-nonterminal">$t</span>)<span class="kw-2">*</span>)
<a href=#75 id=75 data-nosnippet>75</a> }
<a href=#76 id=76 data-nosnippet>76</a>}
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a><span class="macro">macro_rules!</span> warn {
<a href=#79 id=79 data-nosnippet>79</a> ($(<span class="macro-nonterminal">$t</span>:tt)<span class="kw-2">*</span>) =&gt; {
<a href=#80 id=80 data-nosnippet>80</a> <span class="macro">log!</span>(warn, $(<span class="macro-nonterminal">$t</span>)<span class="kw-2">*</span>)
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a>}
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a><span class="macro">macro_rules!</span> error {
<a href=#85 id=85 data-nosnippet>85</a> ($(<span class="macro-nonterminal">$t</span>:tt)<span class="kw-2">*</span>) =&gt; {
<a href=#86 id=86 data-nosnippet>86</a> <span class="macro">log!</span>(error, $(<span class="macro-nonterminal">$t</span>)<span class="kw-2">*</span>)
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a>}
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a><span class="macro">macro_rules!</span> log {
<a href=#91 id=91 data-nosnippet>91</a> (<span class="macro-nonterminal">$level</span>: ident, $(<span class="macro-nonterminal">$t</span>:tt)<span class="kw-2">*</span>) =&gt; {
<a href=#92 id=92 data-nosnippet>92</a> <span class="attr">#[cfg(feature = <span class="string">"log"</span>)]
<a href=#93 id=93 data-nosnippet>93</a> </span>{ log::<span class="macro-nonterminal">$level</span>!($(<span class="macro-nonterminal">$t</span>)<span class="kw-2">*</span>) }
<a href=#94 id=94 data-nosnippet>94</a> <span class="comment">// Silence unused variables warnings.
<a href=#95 id=95 data-nosnippet>95</a> </span><span class="attr">#[cfg(not(feature = <span class="string">"log"</span>))]
<a href=#96 id=96 data-nosnippet>96</a> </span>{ <span class="kw">if </span><span class="bool-val">false </span>{ <span class="kw">let _ </span>= ( $(<span class="macro-nonterminal">$t</span>)* ); } }
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>}
</code></pre></div></section></main></body></html>
+40
View File
@@ -0,0 +1,40 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Networking primitives.
<a href=#2 id=2 data-nosnippet>2</a>//!
<a href=#3 id=3 data-nosnippet>3</a>//! The types provided in this module are non-blocking by default and are
<a href=#4 id=4 data-nosnippet>4</a>//! designed to be portable across all supported Mio platforms. As long as the
<a href=#5 id=5 data-nosnippet>5</a>//! [portability guidelines] are followed, the behavior should be identical no
<a href=#6 id=6 data-nosnippet>6</a>//! matter the target platform.
<a href=#7 id=7 data-nosnippet>7</a>//!
<a href=#8 id=8 data-nosnippet>8</a>//! [portability guidelines]: ../struct.Poll.html#portability
<a href=#9 id=9 data-nosnippet>9</a>//!
<a href=#10 id=10 data-nosnippet>10</a>//! # Notes
<a href=#11 id=11 data-nosnippet>11</a>//!
<a href=#12 id=12 data-nosnippet>12</a>//! When using a datagram based socket, i.e. [`UdpSocket`] or [`UnixDatagram`],
<a href=#13 id=13 data-nosnippet>13</a>//! it's only possible to receive a packet once. This means that if you provide a
<a href=#14 id=14 data-nosnippet>14</a>//! buffer that is too small you won't be able to receive the data anymore. How
<a href=#15 id=15 data-nosnippet>15</a>//! OSs deal with this situation is different for each OS:
<a href=#16 id=16 data-nosnippet>16</a>//! * Unixes, such as Linux, FreeBSD and macOS, will simply fill the buffer and
<a href=#17 id=17 data-nosnippet>17</a>//! return the amount of bytes written. This means that if the returned value
<a href=#18 id=18 data-nosnippet>18</a>//! is equal to the size of the buffer it may have only written a part of the
<a href=#19 id=19 data-nosnippet>19</a>//! packet (or the packet has the same size as the buffer).
<a href=#20 id=20 data-nosnippet>20</a>//! * Windows returns an `WSAEMSGSIZE` error.
<a href=#21 id=21 data-nosnippet>21</a>//!
<a href=#22 id=22 data-nosnippet>22</a>//! Mio does not change the value (either ok or error) returned by the OS, it's
<a href=#23 id=23 data-nosnippet>23</a>//! up to the user to handle this. How to deal with these differences is still up
<a href=#24 id=24 data-nosnippet>24</a>//! for debate, specifically in
<a href=#25 id=25 data-nosnippet>25</a>//! &lt;https://github.com/rust-lang/rust/issues/55794&gt;. The best advice we can
<a href=#26 id=26 data-nosnippet>26</a>//! give is to always call receive with a large enough buffer.
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a></span><span class="kw">mod </span>tcp;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">pub use </span><span class="self">self</span>::tcp::{TcpListener, TcpStream};
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#32 id=32 data-nosnippet>32</a></span><span class="kw">mod </span>udp;
<a href=#33 id=33 data-nosnippet>33</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#34 id=34 data-nosnippet>34</a></span><span class="kw">pub use </span><span class="self">self</span>::udp::UdpSocket;
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a><span class="attr">#[cfg(unix)]
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">mod </span>uds;
<a href=#38 id=38 data-nosnippet>38</a><span class="attr">#[cfg(unix)]
<a href=#39 id=39 data-nosnippet>39</a></span><span class="kw">pub use </span><span class="self">self</span>::uds::{UnixDatagram, UnixListener, UnixStream};
</code></pre></div></section></main></body></html>
+301
View File
@@ -0,0 +1,301 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/tcp/listener.rs`."><title>listener.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/tcp/</div>listener.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::net::{<span class="self">self</span>, SocketAddr};
<a href=#2 id=2 data-nosnippet>2</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"wasi"</span>))]
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>std::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#4 id=4 data-nosnippet>4</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#5 id=5 data-nosnippet>5</a>// can use `std::os::fd` and be merged with the above.
<a href=#6 id=6 data-nosnippet>6</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">use </span>std::os::hermit::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#8 id=8 data-nosnippet>8</a><span class="attr">#[cfg(windows)]
<a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">use </span>std::os::windows::io::{
<a href=#10 id=10 data-nosnippet>10</a> AsRawSocket, AsSocket, BorrowedSocket, FromRawSocket, IntoRawSocket, OwnedSocket, RawSocket,
<a href=#11 id=11 data-nosnippet>11</a>};
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>std::{fmt, io};
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">use </span><span class="kw">crate</span>::net::TcpStream;
<a href=#16 id=16 data-nosnippet>16</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>))]
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">use </span><span class="kw">crate</span>::sys::tcp::set_reuseaddr;
<a href=#18 id=18 data-nosnippet>18</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#19 id=19 data-nosnippet>19</a></span><span class="kw">use </span><span class="kw">crate</span>::sys::{
<a href=#20 id=20 data-nosnippet>20</a> tcp::{bind, listen, new_for_addr},
<a href=#21 id=21 data-nosnippet>21</a> LISTEN_BACKLOG_SIZE,
<a href=#22 id=22 data-nosnippet>22</a>};
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use crate</span>::{event, sys, Interest, Registry, Token};
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="doccomment">/// A structure representing a socket server
<a href=#26 id=26 data-nosnippet>26</a>///
<a href=#27 id=27 data-nosnippet>27</a>/// # Examples
<a href=#28 id=28 data-nosnippet>28</a>///
<a href=#29 id=29 data-nosnippet>29</a></span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#30 id=30 data-nosnippet>30</a>#[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#31 id=31 data-nosnippet>31</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#32 id=32 data-nosnippet>32</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#33 id=33 data-nosnippet>33</a>/// use mio::{Events, Interest, Poll, Token};
<a href=#34 id=34 data-nosnippet>34</a>/// use mio::net::TcpListener;
<a href=#35 id=35 data-nosnippet>35</a>/// use std::time::Duration;
<a href=#36 id=36 data-nosnippet>36</a>///
<a href=#37 id=37 data-nosnippet>37</a>/// let mut listener = TcpListener::bind("127.0.0.1:34255".parse()?)?;
<a href=#38 id=38 data-nosnippet>38</a>///
<a href=#39 id=39 data-nosnippet>39</a>/// let mut poll = Poll::new()?;
<a href=#40 id=40 data-nosnippet>40</a>/// let mut events = Events::with_capacity(128);
<a href=#41 id=41 data-nosnippet>41</a>///
<a href=#42 id=42 data-nosnippet>42</a>/// // Register the socket with `Poll`
<a href=#43 id=43 data-nosnippet>43</a>/// poll.registry().register(&amp;mut listener, Token(0), Interest::READABLE)?;
<a href=#44 id=44 data-nosnippet>44</a>///
<a href=#45 id=45 data-nosnippet>45</a>/// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#46 id=46 data-nosnippet>46</a>///
<a href=#47 id=47 data-nosnippet>47</a>/// // There may be a socket ready to be accepted
<a href=#48 id=48 data-nosnippet>48</a>/// # Ok(())
<a href=#49 id=49 data-nosnippet>49</a>/// # }
<a href=#50 id=50 data-nosnippet>50</a>/// ```
<a href=#51 id=51 data-nosnippet>51</a></span><span class="kw">pub struct </span>TcpListener {
<a href=#52 id=52 data-nosnippet>52</a> inner: IoSource&lt;net::TcpListener&gt;,
<a href=#53 id=53 data-nosnippet>53</a>}
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a><span class="kw">impl </span>TcpListener {
<a href=#56 id=56 data-nosnippet>56</a> <span class="doccomment">/// Convenience method to bind a new TCP listener to the specified address
<a href=#57 id=57 data-nosnippet>57</a> /// to receive new connections.
<a href=#58 id=58 data-nosnippet>58</a> ///
<a href=#59 id=59 data-nosnippet>59</a> /// This function will take the following steps:
<a href=#60 id=60 data-nosnippet>60</a> ///
<a href=#61 id=61 data-nosnippet>61</a> /// 1. Create a new TCP socket.
<a href=#62 id=62 data-nosnippet>62</a> /// 2. Set the `SO_REUSEADDR` option on the socket on Unix.
<a href=#63 id=63 data-nosnippet>63</a> /// 3. Bind the socket to the specified address.
<a href=#64 id=64 data-nosnippet>64</a> /// 4. Calls `listen` on the socket to prepare it to receive new connections.
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#66 id=66 data-nosnippet>66</a> </span><span class="kw">pub fn </span>bind(addr: SocketAddr) -&gt; io::Result&lt;TcpListener&gt; {
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let </span>socket = new_for_addr(addr)<span class="question-mark">?</span>;
<a href=#68 id=68 data-nosnippet>68</a> <span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>))]
<a href=#69 id=69 data-nosnippet>69</a> </span><span class="kw">let </span>listener = <span class="kw">unsafe </span>{ TcpListener::from_raw_fd(socket) };
<a href=#70 id=70 data-nosnippet>70</a> <span class="attr">#[cfg(windows)]
<a href=#71 id=71 data-nosnippet>71</a> </span><span class="kw">let </span>listener = <span class="kw">unsafe </span>{ TcpListener::from_raw_socket(socket <span class="kw">as _</span>) };
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="comment">// On platforms with Berkeley-derived sockets, this allows to quickly
<a href=#74 id=74 data-nosnippet>74</a> // rebind a socket, without needing to wait for the OS to clean up the
<a href=#75 id=75 data-nosnippet>75</a> // previous one.
<a href=#76 id=76 data-nosnippet>76</a> //
<a href=#77 id=77 data-nosnippet>77</a> // On Windows, this allows rebinding sockets which are actively in use,
<a href=#78 id=78 data-nosnippet>78</a> // which allows “socket hijacking”, so we explicitly don't set it here.
<a href=#79 id=79 data-nosnippet>79</a> // https://docs.microsoft.com/en-us/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="attr">#[cfg(not(windows))]
<a href=#81 id=81 data-nosnippet>81</a> </span>set_reuseaddr(<span class="kw-2">&amp;</span>listener.inner, <span class="bool-val">true</span>)<span class="question-mark">?</span>;
<a href=#82 id=82 data-nosnippet>82</a>
<a href=#83 id=83 data-nosnippet>83</a> bind(<span class="kw-2">&amp;</span>listener.inner, addr)<span class="question-mark">?</span>;
<a href=#84 id=84 data-nosnippet>84</a> listen(<span class="kw-2">&amp;</span>listener.inner, LISTEN_BACKLOG_SIZE)<span class="question-mark">?</span>;
<a href=#85 id=85 data-nosnippet>85</a> <span class="prelude-val">Ok</span>(listener)
<a href=#86 id=86 data-nosnippet>86</a> }
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a> <span class="doccomment">/// Creates a new `TcpListener` from a standard `net::TcpListener`.
<a href=#89 id=89 data-nosnippet>89</a> ///
<a href=#90 id=90 data-nosnippet>90</a> /// This function is intended to be used to wrap a TCP listener from the
<a href=#91 id=91 data-nosnippet>91</a> /// standard library in the Mio equivalent. The conversion assumes nothing
<a href=#92 id=92 data-nosnippet>92</a> /// about the underlying listener; it is left up to the user to set it
<a href=#93 id=93 data-nosnippet>93</a> /// into non-blocking mode.
<a href=#94 id=94 data-nosnippet>94</a> </span><span class="kw">pub fn </span>from_std(listener: net::TcpListener) -&gt; TcpListener {
<a href=#95 id=95 data-nosnippet>95</a> TcpListener {
<a href=#96 id=96 data-nosnippet>96</a> inner: IoSource::new(listener),
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a> }
<a href=#99 id=99 data-nosnippet>99</a>
<a href=#100 id=100 data-nosnippet>100</a> <span class="doccomment">/// Accepts a new `TcpStream`.
<a href=#101 id=101 data-nosnippet>101</a> ///
<a href=#102 id=102 data-nosnippet>102</a> /// This may return an `Err(e)` where `e.kind()` is
<a href=#103 id=103 data-nosnippet>103</a> /// `io::ErrorKind::WouldBlock`. This means a stream may be ready at a later
<a href=#104 id=104 data-nosnippet>104</a> /// point and one should wait for an event before calling `accept` again.
<a href=#105 id=105 data-nosnippet>105</a> ///
<a href=#106 id=106 data-nosnippet>106</a> /// If an accepted stream is returned, the remote address of the peer is
<a href=#107 id=107 data-nosnippet>107</a> /// returned along with it.
<a href=#108 id=108 data-nosnippet>108</a> </span><span class="kw">pub fn </span>accept(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;(TcpStream, SocketAddr)&gt; {
<a href=#109 id=109 data-nosnippet>109</a> <span class="self">self</span>.inner.do_io(|inner| {
<a href=#110 id=110 data-nosnippet>110</a> sys::tcp::accept(inner).map(|(stream, addr)| (TcpStream::from_std(stream), addr))
<a href=#111 id=111 data-nosnippet>111</a> })
<a href=#112 id=112 data-nosnippet>112</a> }
<a href=#113 id=113 data-nosnippet>113</a>
<a href=#114 id=114 data-nosnippet>114</a> <span class="doccomment">/// Returns the local socket address of this listener.
<a href=#115 id=115 data-nosnippet>115</a> </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#116 id=116 data-nosnippet>116</a> <span class="self">self</span>.inner.local_addr()
<a href=#117 id=117 data-nosnippet>117</a> }
<a href=#118 id=118 data-nosnippet>118</a>
<a href=#119 id=119 data-nosnippet>119</a> <span class="doccomment">/// Sets the value for the `IP_TTL` option on this socket.
<a href=#120 id=120 data-nosnippet>120</a> ///
<a href=#121 id=121 data-nosnippet>121</a> /// This value sets the time-to-live field that is used in every packet sent
<a href=#122 id=122 data-nosnippet>122</a> /// from this socket.
<a href=#123 id=123 data-nosnippet>123</a> </span><span class="kw">pub fn </span>set_ttl(<span class="kw-2">&amp;</span><span class="self">self</span>, ttl: u32) -&gt; io::Result&lt;()&gt; {
<a href=#124 id=124 data-nosnippet>124</a> <span class="self">self</span>.inner.set_ttl(ttl)
<a href=#125 id=125 data-nosnippet>125</a> }
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a> <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket.
<a href=#128 id=128 data-nosnippet>128</a> ///
<a href=#129 id=129 data-nosnippet>129</a> /// For more information about this option, see [`set_ttl`][link].
<a href=#130 id=130 data-nosnippet>130</a> ///
<a href=#131 id=131 data-nosnippet>131</a> /// [link]: #method.set_ttl
<a href=#132 id=132 data-nosnippet>132</a> </span><span class="kw">pub fn </span>ttl(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;u32&gt; {
<a href=#133 id=133 data-nosnippet>133</a> <span class="self">self</span>.inner.ttl()
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="doccomment">/// Get the value of the `SO_ERROR` option on this socket.
<a href=#137 id=137 data-nosnippet>137</a> ///
<a href=#138 id=138 data-nosnippet>138</a> /// This will retrieve the stored error in the underlying socket, clearing
<a href=#139 id=139 data-nosnippet>139</a> /// the field in the process. This can be useful for checking errors between
<a href=#140 id=140 data-nosnippet>140</a> /// calls.
<a href=#141 id=141 data-nosnippet>141</a> </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;io::Error&gt;&gt; {
<a href=#142 id=142 data-nosnippet>142</a> <span class="self">self</span>.inner.take_error()
<a href=#143 id=143 data-nosnippet>143</a> }
<a href=#144 id=144 data-nosnippet>144</a>}
<a href=#145 id=145 data-nosnippet>145</a>
<a href=#146 id=146 data-nosnippet>146</a><span class="kw">impl </span>event::Source <span class="kw">for </span>TcpListener {
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">fn </span>register(
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#149 id=149 data-nosnippet>149</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#150 id=150 data-nosnippet>150</a> token: Token,
<a href=#151 id=151 data-nosnippet>151</a> interests: Interest,
<a href=#152 id=152 data-nosnippet>152</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#153 id=153 data-nosnippet>153</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#154 id=154 data-nosnippet>154</a> }
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">fn </span>reregister(
<a href=#157 id=157 data-nosnippet>157</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#158 id=158 data-nosnippet>158</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#159 id=159 data-nosnippet>159</a> token: Token,
<a href=#160 id=160 data-nosnippet>160</a> interests: Interest,
<a href=#161 id=161 data-nosnippet>161</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#162 id=162 data-nosnippet>162</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#163 id=163 data-nosnippet>163</a> }
<a href=#164 id=164 data-nosnippet>164</a>
<a href=#165 id=165 data-nosnippet>165</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#166 id=166 data-nosnippet>166</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#167 id=167 data-nosnippet>167</a> }
<a href=#168 id=168 data-nosnippet>168</a>}
<a href=#169 id=169 data-nosnippet>169</a>
<a href=#170 id=170 data-nosnippet>170</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TcpListener {
<a href=#171 id=171 data-nosnippet>171</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#172 id=172 data-nosnippet>172</a> <span class="self">self</span>.inner.fmt(f)
<a href=#173 id=173 data-nosnippet>173</a> }
<a href=#174 id=174 data-nosnippet>174</a>}
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#177 id=177 data-nosnippet>177</a></span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>TcpListener {
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#179 id=179 data-nosnippet>179</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#180 id=180 data-nosnippet>180</a> }
<a href=#181 id=181 data-nosnippet>181</a>}
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#184 id=184 data-nosnippet>184</a></span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>TcpListener {
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#186 id=186 data-nosnippet>186</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#187 id=187 data-nosnippet>187</a> }
<a href=#188 id=188 data-nosnippet>188</a>}
<a href=#189 id=189 data-nosnippet>189</a>
<a href=#190 id=190 data-nosnippet>190</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#191 id=191 data-nosnippet>191</a></span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>TcpListener {
<a href=#192 id=192 data-nosnippet>192</a> <span class="doccomment">/// Converts a `RawFd` to a `TcpListener`.
<a href=#193 id=193 data-nosnippet>193</a> ///
<a href=#194 id=194 data-nosnippet>194</a> /// # Notes
<a href=#195 id=195 data-nosnippet>195</a> ///
<a href=#196 id=196 data-nosnippet>196</a> /// The caller is responsible for ensuring that the socket is in
<a href=#197 id=197 data-nosnippet>197</a> /// non-blocking mode.
<a href=#198 id=198 data-nosnippet>198</a> </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; TcpListener {
<a href=#199 id=199 data-nosnippet>199</a> TcpListener::from_std(FromRawFd::from_raw_fd(fd))
<a href=#200 id=200 data-nosnippet>200</a> }
<a href=#201 id=201 data-nosnippet>201</a>}
<a href=#202 id=202 data-nosnippet>202</a>
<a href=#203 id=203 data-nosnippet>203</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#204 id=204 data-nosnippet>204</a></span><span class="kw">impl </span>From&lt;TcpListener&gt; <span class="kw">for </span>OwnedFd {
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">fn </span>from(tcp_listener: TcpListener) -&gt; <span class="self">Self </span>{
<a href=#206 id=206 data-nosnippet>206</a> tcp_listener.inner.into_inner().into()
<a href=#207 id=207 data-nosnippet>207</a> }
<a href=#208 id=208 data-nosnippet>208</a>}
<a href=#209 id=209 data-nosnippet>209</a>
<a href=#210 id=210 data-nosnippet>210</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#211 id=211 data-nosnippet>211</a></span><span class="kw">impl </span>AsFd <span class="kw">for </span>TcpListener {
<a href=#212 id=212 data-nosnippet>212</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#213 id=213 data-nosnippet>213</a> <span class="self">self</span>.inner.as_fd()
<a href=#214 id=214 data-nosnippet>214</a> }
<a href=#215 id=215 data-nosnippet>215</a>}
<a href=#216 id=216 data-nosnippet>216</a>
<a href=#217 id=217 data-nosnippet>217</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#218 id=218 data-nosnippet>218</a></span><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>TcpListener {
<a href=#219 id=219 data-nosnippet>219</a> <span class="doccomment">/// Converts a `RawFd` to a `TcpListener`.
<a href=#220 id=220 data-nosnippet>220</a> ///
<a href=#221 id=221 data-nosnippet>221</a> /// # Notes
<a href=#222 id=222 data-nosnippet>222</a> ///
<a href=#223 id=223 data-nosnippet>223</a> /// The caller is responsible for ensuring that the socket is in
<a href=#224 id=224 data-nosnippet>224</a> /// non-blocking mode.
<a href=#225 id=225 data-nosnippet>225</a> </span><span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#226 id=226 data-nosnippet>226</a> TcpListener::from_std(From::from(fd))
<a href=#227 id=227 data-nosnippet>227</a> }
<a href=#228 id=228 data-nosnippet>228</a>}
<a href=#229 id=229 data-nosnippet>229</a>
<a href=#230 id=230 data-nosnippet>230</a><span class="attr">#[cfg(windows)]
<a href=#231 id=231 data-nosnippet>231</a></span><span class="kw">impl </span>IntoRawSocket <span class="kw">for </span>TcpListener {
<a href=#232 id=232 data-nosnippet>232</a> <span class="kw">fn </span>into_raw_socket(<span class="self">self</span>) -&gt; RawSocket {
<a href=#233 id=233 data-nosnippet>233</a> <span class="self">self</span>.inner.into_inner().into_raw_socket()
<a href=#234 id=234 data-nosnippet>234</a> }
<a href=#235 id=235 data-nosnippet>235</a>}
<a href=#236 id=236 data-nosnippet>236</a>
<a href=#237 id=237 data-nosnippet>237</a><span class="attr">#[cfg(windows)]
<a href=#238 id=238 data-nosnippet>238</a></span><span class="kw">impl </span>AsRawSocket <span class="kw">for </span>TcpListener {
<a href=#239 id=239 data-nosnippet>239</a> <span class="kw">fn </span>as_raw_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawSocket {
<a href=#240 id=240 data-nosnippet>240</a> <span class="self">self</span>.inner.as_raw_socket()
<a href=#241 id=241 data-nosnippet>241</a> }
<a href=#242 id=242 data-nosnippet>242</a>}
<a href=#243 id=243 data-nosnippet>243</a>
<a href=#244 id=244 data-nosnippet>244</a><span class="attr">#[cfg(windows)]
<a href=#245 id=245 data-nosnippet>245</a></span><span class="kw">impl </span>FromRawSocket <span class="kw">for </span>TcpListener {
<a href=#246 id=246 data-nosnippet>246</a> <span class="doccomment">/// Converts a `RawSocket` to a `TcpListener`.
<a href=#247 id=247 data-nosnippet>247</a> ///
<a href=#248 id=248 data-nosnippet>248</a> /// # Notes
<a href=#249 id=249 data-nosnippet>249</a> ///
<a href=#250 id=250 data-nosnippet>250</a> /// The caller is responsible for ensuring that the socket is in
<a href=#251 id=251 data-nosnippet>251</a> /// non-blocking mode.
<a href=#252 id=252 data-nosnippet>252</a> </span><span class="kw">unsafe fn </span>from_raw_socket(socket: RawSocket) -&gt; TcpListener {
<a href=#253 id=253 data-nosnippet>253</a> TcpListener::from_std(FromRawSocket::from_raw_socket(socket))
<a href=#254 id=254 data-nosnippet>254</a> }
<a href=#255 id=255 data-nosnippet>255</a>}
<a href=#256 id=256 data-nosnippet>256</a>
<a href=#257 id=257 data-nosnippet>257</a><span class="attr">#[cfg(windows)]
<a href=#258 id=258 data-nosnippet>258</a></span><span class="kw">impl </span>From&lt;TcpListener&gt; <span class="kw">for </span>OwnedSocket {
<a href=#259 id=259 data-nosnippet>259</a> <span class="kw">fn </span>from(tcp_listener: TcpListener) -&gt; <span class="self">Self </span>{
<a href=#260 id=260 data-nosnippet>260</a> tcp_listener.inner.into_inner().into()
<a href=#261 id=261 data-nosnippet>261</a> }
<a href=#262 id=262 data-nosnippet>262</a>}
<a href=#263 id=263 data-nosnippet>263</a>
<a href=#264 id=264 data-nosnippet>264</a><span class="attr">#[cfg(windows)]
<a href=#265 id=265 data-nosnippet>265</a></span><span class="kw">impl </span>AsSocket <span class="kw">for </span>TcpListener {
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">fn </span>as_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedSocket&lt;<span class="lifetime">'_</span>&gt; {
<a href=#267 id=267 data-nosnippet>267</a> <span class="self">self</span>.inner.as_socket()
<a href=#268 id=268 data-nosnippet>268</a> }
<a href=#269 id=269 data-nosnippet>269</a>}
<a href=#270 id=270 data-nosnippet>270</a>
<a href=#271 id=271 data-nosnippet>271</a><span class="attr">#[cfg(windows)]
<a href=#272 id=272 data-nosnippet>272</a></span><span class="kw">impl </span>From&lt;OwnedSocket&gt; <span class="kw">for </span>TcpListener {
<a href=#273 id=273 data-nosnippet>273</a> <span class="doccomment">/// Converts a `RawSocket` to a `TcpListener`.
<a href=#274 id=274 data-nosnippet>274</a> ///
<a href=#275 id=275 data-nosnippet>275</a> /// # Notes
<a href=#276 id=276 data-nosnippet>276</a> ///
<a href=#277 id=277 data-nosnippet>277</a> /// The caller is responsible for ensuring that the socket is in
<a href=#278 id=278 data-nosnippet>278</a> /// non-blocking mode.
<a href=#279 id=279 data-nosnippet>279</a> </span><span class="kw">fn </span>from(socket: OwnedSocket) -&gt; <span class="self">Self </span>{
<a href=#280 id=280 data-nosnippet>280</a> TcpListener::from_std(From::from(socket))
<a href=#281 id=281 data-nosnippet>281</a> }
<a href=#282 id=282 data-nosnippet>282</a>}
<a href=#283 id=283 data-nosnippet>283</a>
<a href=#284 id=284 data-nosnippet>284</a><span class="kw">impl </span>From&lt;TcpListener&gt; <span class="kw">for </span>net::TcpListener {
<a href=#285 id=285 data-nosnippet>285</a> <span class="kw">fn </span>from(listener: TcpListener) -&gt; <span class="self">Self </span>{
<a href=#286 id=286 data-nosnippet>286</a> <span class="comment">// Safety: This is safe since we are extracting the raw fd from a well-constructed
<a href=#287 id=287 data-nosnippet>287</a> // mio::net::TcpListener which ensures that we actually pass in a valid file
<a href=#288 id=288 data-nosnippet>288</a> // descriptor/socket
<a href=#289 id=289 data-nosnippet>289</a> </span><span class="kw">unsafe </span>{
<a href=#290 id=290 data-nosnippet>290</a> <span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#291 id=291 data-nosnippet>291</a> </span>{
<a href=#292 id=292 data-nosnippet>292</a> net::TcpListener::from_raw_fd(listener.into_raw_fd())
<a href=#293 id=293 data-nosnippet>293</a> }
<a href=#294 id=294 data-nosnippet>294</a> <span class="attr">#[cfg(windows)]
<a href=#295 id=295 data-nosnippet>295</a> </span>{
<a href=#296 id=296 data-nosnippet>296</a> net::TcpListener::from_raw_socket(listener.into_raw_socket())
<a href=#297 id=297 data-nosnippet>297</a> }
<a href=#298 id=298 data-nosnippet>298</a> }
<a href=#299 id=299 data-nosnippet>299</a> }
<a href=#300 id=300 data-nosnippet>300</a>}
</code></pre></div></section></main></body></html>
+6
View File
@@ -0,0 +1,6 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/tcp/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/tcp/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-1"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>listener;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">pub use </span><span class="self">self</span>::listener::TcpListener;
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">mod </span>stream;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub use </span><span class="self">self</span>::stream::TcpStream;
</code></pre></div></section></main></body></html>
+482
View File
@@ -0,0 +1,482 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/tcp/stream.rs`."><title>stream.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/tcp/</div>stream.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::fmt;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::io::{<span class="self">self</span>, IoSlice, IoSliceMut, Read, Write};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::net::{<span class="self">self</span>, Shutdown, SocketAddr};
<a href=#4 id=4 data-nosnippet>4</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"wasi"</span>))]
<a href=#5 id=5 data-nosnippet>5</a></span><span class="kw">use </span>std::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#6 id=6 data-nosnippet>6</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#7 id=7 data-nosnippet>7</a>// can use `std::os::fd` and be merged with the above.
<a href=#8 id=8 data-nosnippet>8</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">use </span>std::os::hermit::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#10 id=10 data-nosnippet>10</a><span class="attr">#[cfg(windows)]
<a href=#11 id=11 data-nosnippet>11</a></span><span class="kw">use </span>std::os::windows::io::{
<a href=#12 id=12 data-nosnippet>12</a> AsRawSocket, AsSocket, BorrowedSocket, FromRawSocket, IntoRawSocket, OwnedSocket, RawSocket,
<a href=#13 id=13 data-nosnippet>13</a>};
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
<a href=#16 id=16 data-nosnippet>16</a><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">use </span><span class="kw">crate</span>::sys::tcp::{connect, new_for_addr};
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use crate</span>::{event, Interest, Registry, Token};
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="doccomment">/// A non-blocking TCP stream between a local socket and a remote socket.
<a href=#21 id=21 data-nosnippet>21</a>///
<a href=#22 id=22 data-nosnippet>22</a>/// The socket will be closed when the value is dropped.
<a href=#23 id=23 data-nosnippet>23</a>///
<a href=#24 id=24 data-nosnippet>24</a>/// # Examples
<a href=#25 id=25 data-nosnippet>25</a>///
<a href=#26 id=26 data-nosnippet>26</a></span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#27 id=27 data-nosnippet>27</a>#[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#28 id=28 data-nosnippet>28</a></span><span class="doccomment">/// # use std::net::{TcpListener, SocketAddr};
<a href=#29 id=29 data-nosnippet>29</a>/// # use std::error::Error;
<a href=#30 id=30 data-nosnippet>30</a>/// #
<a href=#31 id=31 data-nosnippet>31</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#32 id=32 data-nosnippet>32</a>/// let address: SocketAddr = "127.0.0.1:0".parse()?;
<a href=#33 id=33 data-nosnippet>33</a>/// let listener = TcpListener::bind(address)?;
<a href=#34 id=34 data-nosnippet>34</a>/// use mio::{Events, Interest, Poll, Token};
<a href=#35 id=35 data-nosnippet>35</a>/// use mio::net::TcpStream;
<a href=#36 id=36 data-nosnippet>36</a>/// use std::time::Duration;
<a href=#37 id=37 data-nosnippet>37</a>///
<a href=#38 id=38 data-nosnippet>38</a>/// let mut stream = TcpStream::connect(listener.local_addr()?)?;
<a href=#39 id=39 data-nosnippet>39</a>///
<a href=#40 id=40 data-nosnippet>40</a>/// let mut poll = Poll::new()?;
<a href=#41 id=41 data-nosnippet>41</a>/// let mut events = Events::with_capacity(128);
<a href=#42 id=42 data-nosnippet>42</a>///
<a href=#43 id=43 data-nosnippet>43</a>/// // Register the socket with `Poll`
<a href=#44 id=44 data-nosnippet>44</a>/// poll.registry().register(&amp;mut stream, Token(0), Interest::WRITABLE)?;
<a href=#45 id=45 data-nosnippet>45</a>///
<a href=#46 id=46 data-nosnippet>46</a>/// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#47 id=47 data-nosnippet>47</a>///
<a href=#48 id=48 data-nosnippet>48</a>/// // The socket might be ready at this point
<a href=#49 id=49 data-nosnippet>49</a>/// # Ok(())
<a href=#50 id=50 data-nosnippet>50</a>/// # }
<a href=#51 id=51 data-nosnippet>51</a>/// ```
<a href=#52 id=52 data-nosnippet>52</a></span><span class="kw">pub struct </span>TcpStream {
<a href=#53 id=53 data-nosnippet>53</a> inner: IoSource&lt;net::TcpStream&gt;,
<a href=#54 id=54 data-nosnippet>54</a>}
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a><span class="kw">impl </span>TcpStream {
<a href=#57 id=57 data-nosnippet>57</a> <span class="doccomment">/// Create a new TCP stream and issue a non-blocking connect to the
<a href=#58 id=58 data-nosnippet>58</a> /// specified address.
<a href=#59 id=59 data-nosnippet>59</a> ///
<a href=#60 id=60 data-nosnippet>60</a> /// # Notes
<a href=#61 id=61 data-nosnippet>61</a> ///
<a href=#62 id=62 data-nosnippet>62</a> /// The returned `TcpStream` may not be connected (and thus usable), unlike
<a href=#63 id=63 data-nosnippet>63</a> /// the API found in `std::net::TcpStream`. Because Mio issues a
<a href=#64 id=64 data-nosnippet>64</a> /// *non-blocking* connect it will not block the thread and instead return
<a href=#65 id=65 data-nosnippet>65</a> /// an unconnected `TcpStream`.
<a href=#66 id=66 data-nosnippet>66</a> ///
<a href=#67 id=67 data-nosnippet>67</a> /// Ensuring the returned stream is connected is surprisingly complex when
<a href=#68 id=68 data-nosnippet>68</a> /// considering cross-platform support. Doing this properly should follow
<a href=#69 id=69 data-nosnippet>69</a> /// the steps below, an example implementation can be found
<a href=#70 id=70 data-nosnippet>70</a> /// [here](https://github.com/Thomasdezeeuw/heph/blob/0c4f1ab3eaf08bea1d65776528bfd6114c9f8374/src/net/tcp/stream.rs#L560-L622).
<a href=#71 id=71 data-nosnippet>71</a> ///
<a href=#72 id=72 data-nosnippet>72</a> /// 1. Call `TcpStream::connect`
<a href=#73 id=73 data-nosnippet>73</a> /// 2. Register the returned stream with at least [write interest].
<a href=#74 id=74 data-nosnippet>74</a> /// 3. Wait for a (writable) event.
<a href=#75 id=75 data-nosnippet>75</a> /// 4. Check `TcpStream::take_error`. If it returns an error, then
<a href=#76 id=76 data-nosnippet>76</a> /// something went wrong. If it returns `Ok(None)`, then proceed to
<a href=#77 id=77 data-nosnippet>77</a> /// step 5.
<a href=#78 id=78 data-nosnippet>78</a> /// 5. Check `TcpStream::peer_addr`. If it returns `libc::EINPROGRESS` or
<a href=#79 id=79 data-nosnippet>79</a> /// `ErrorKind::NotConnected` it means the stream is not yet connected,
<a href=#80 id=80 data-nosnippet>80</a> /// go back to step 3. If it returns an address it means the stream is
<a href=#81 id=81 data-nosnippet>81</a> /// connected, go to step 6. If another error is returned something
<a href=#82 id=82 data-nosnippet>82</a> /// went wrong.
<a href=#83 id=83 data-nosnippet>83</a> /// 6. Now the stream can be used.
<a href=#84 id=84 data-nosnippet>84</a> ///
<a href=#85 id=85 data-nosnippet>85</a> /// This may return a `WouldBlock` in which case the socket connection
<a href=#86 id=86 data-nosnippet>86</a> /// cannot be completed immediately, it usually means there are insufficient
<a href=#87 id=87 data-nosnippet>87</a> /// entries in the routing cache.
<a href=#88 id=88 data-nosnippet>88</a> ///
<a href=#89 id=89 data-nosnippet>89</a> /// [write interest]: Interest::WRITABLE
<a href=#90 id=90 data-nosnippet>90</a> </span><span class="attr">#[cfg(not(target_os = <span class="string">"wasi"</span>))]
<a href=#91 id=91 data-nosnippet>91</a> </span><span class="kw">pub fn </span>connect(addr: SocketAddr) -&gt; io::Result&lt;TcpStream&gt; {
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">let </span>socket = new_for_addr(addr)<span class="question-mark">?</span>;
<a href=#93 id=93 data-nosnippet>93</a> <span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>))]
<a href=#94 id=94 data-nosnippet>94</a> </span><span class="kw">let </span>stream = <span class="kw">unsafe </span>{ TcpStream::from_raw_fd(socket) };
<a href=#95 id=95 data-nosnippet>95</a> <span class="attr">#[cfg(windows)]
<a href=#96 id=96 data-nosnippet>96</a> </span><span class="kw">let </span>stream = <span class="kw">unsafe </span>{ TcpStream::from_raw_socket(socket <span class="kw">as _</span>) };
<a href=#97 id=97 data-nosnippet>97</a> connect(<span class="kw-2">&amp;</span>stream.inner, addr)<span class="question-mark">?</span>;
<a href=#98 id=98 data-nosnippet>98</a> <span class="prelude-val">Ok</span>(stream)
<a href=#99 id=99 data-nosnippet>99</a> }
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> <span class="doccomment">/// Creates a new `TcpStream` from a standard `net::TcpStream`.
<a href=#102 id=102 data-nosnippet>102</a> ///
<a href=#103 id=103 data-nosnippet>103</a> /// This function is intended to be used to wrap a TCP stream from the
<a href=#104 id=104 data-nosnippet>104</a> /// standard library in the Mio equivalent. The conversion assumes nothing
<a href=#105 id=105 data-nosnippet>105</a> /// about the underlying stream; it is left up to the user to set it in
<a href=#106 id=106 data-nosnippet>106</a> /// non-blocking mode.
<a href=#107 id=107 data-nosnippet>107</a> ///
<a href=#108 id=108 data-nosnippet>108</a> /// # Note
<a href=#109 id=109 data-nosnippet>109</a> ///
<a href=#110 id=110 data-nosnippet>110</a> /// The TCP stream here will not have `connect` called on it, so it
<a href=#111 id=111 data-nosnippet>111</a> /// should already be connected via some other means (be it manually, or
<a href=#112 id=112 data-nosnippet>112</a> /// the standard library).
<a href=#113 id=113 data-nosnippet>113</a> </span><span class="kw">pub fn </span>from_std(stream: net::TcpStream) -&gt; TcpStream {
<a href=#114 id=114 data-nosnippet>114</a> TcpStream {
<a href=#115 id=115 data-nosnippet>115</a> inner: IoSource::new(stream),
<a href=#116 id=116 data-nosnippet>116</a> }
<a href=#117 id=117 data-nosnippet>117</a> }
<a href=#118 id=118 data-nosnippet>118</a>
<a href=#119 id=119 data-nosnippet>119</a> <span class="doccomment">/// Returns the socket address of the remote peer of this TCP connection.
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#121 id=121 data-nosnippet>121</a> <span class="self">self</span>.inner.peer_addr()
<a href=#122 id=122 data-nosnippet>122</a> }
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="doccomment">/// Returns the socket address of the local half of this TCP connection.
<a href=#125 id=125 data-nosnippet>125</a> </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#126 id=126 data-nosnippet>126</a> <span class="self">self</span>.inner.local_addr()
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="doccomment">/// Shuts down the read, write, or both halves of this connection.
<a href=#130 id=130 data-nosnippet>130</a> ///
<a href=#131 id=131 data-nosnippet>131</a> /// This function will cause all pending and future I/O on the specified
<a href=#132 id=132 data-nosnippet>132</a> /// portions to return immediately with an appropriate value (see the
<a href=#133 id=133 data-nosnippet>133</a> /// documentation of `Shutdown`).
<a href=#134 id=134 data-nosnippet>134</a> </span><span class="kw">pub fn </span>shutdown(<span class="kw-2">&amp;</span><span class="self">self</span>, how: Shutdown) -&gt; io::Result&lt;()&gt; {
<a href=#135 id=135 data-nosnippet>135</a> <span class="self">self</span>.inner.shutdown(how)
<a href=#136 id=136 data-nosnippet>136</a> }
<a href=#137 id=137 data-nosnippet>137</a>
<a href=#138 id=138 data-nosnippet>138</a> <span class="doccomment">/// Sets the value of the `TCP_NODELAY` option on this socket.
<a href=#139 id=139 data-nosnippet>139</a> ///
<a href=#140 id=140 data-nosnippet>140</a> /// If set, this option disables the Nagle algorithm. This means that
<a href=#141 id=141 data-nosnippet>141</a> /// segments are always sent as soon as possible, even if there is only a
<a href=#142 id=142 data-nosnippet>142</a> /// small amount of data. When not set, data is buffered until there is a
<a href=#143 id=143 data-nosnippet>143</a> /// sufficient amount to send out, thereby avoiding the frequent sending of
<a href=#144 id=144 data-nosnippet>144</a> /// small packets.
<a href=#145 id=145 data-nosnippet>145</a> ///
<a href=#146 id=146 data-nosnippet>146</a> /// # Notes
<a href=#147 id=147 data-nosnippet>147</a> ///
<a href=#148 id=148 data-nosnippet>148</a> /// On Windows make sure the stream is connected before calling this method,
<a href=#149 id=149 data-nosnippet>149</a> /// by receiving an (writable) event. Trying to set `nodelay` on an
<a href=#150 id=150 data-nosnippet>150</a> /// unconnected `TcpStream` is unspecified behavior.
<a href=#151 id=151 data-nosnippet>151</a> </span><span class="kw">pub fn </span>set_nodelay(<span class="kw-2">&amp;</span><span class="self">self</span>, nodelay: bool) -&gt; io::Result&lt;()&gt; {
<a href=#152 id=152 data-nosnippet>152</a> <span class="self">self</span>.inner.set_nodelay(nodelay)
<a href=#153 id=153 data-nosnippet>153</a> }
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a> <span class="doccomment">/// Gets the value of the `TCP_NODELAY` option on this socket.
<a href=#156 id=156 data-nosnippet>156</a> ///
<a href=#157 id=157 data-nosnippet>157</a> /// For more information about this option, see [`set_nodelay`][link].
<a href=#158 id=158 data-nosnippet>158</a> ///
<a href=#159 id=159 data-nosnippet>159</a> /// [link]: #method.set_nodelay
<a href=#160 id=160 data-nosnippet>160</a> ///
<a href=#161 id=161 data-nosnippet>161</a> /// # Notes
<a href=#162 id=162 data-nosnippet>162</a> ///
<a href=#163 id=163 data-nosnippet>163</a> /// On Windows make sure the stream is connected before calling this method,
<a href=#164 id=164 data-nosnippet>164</a> /// by receiving an (writable) event. Trying to get `nodelay` on an
<a href=#165 id=165 data-nosnippet>165</a> /// unconnected `TcpStream` is unspecified behavior.
<a href=#166 id=166 data-nosnippet>166</a> </span><span class="kw">pub fn </span>nodelay(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;bool&gt; {
<a href=#167 id=167 data-nosnippet>167</a> <span class="self">self</span>.inner.nodelay()
<a href=#168 id=168 data-nosnippet>168</a> }
<a href=#169 id=169 data-nosnippet>169</a>
<a href=#170 id=170 data-nosnippet>170</a> <span class="doccomment">/// Sets the value for the `IP_TTL` option on this socket.
<a href=#171 id=171 data-nosnippet>171</a> ///
<a href=#172 id=172 data-nosnippet>172</a> /// This value sets the time-to-live field that is used in every packet sent
<a href=#173 id=173 data-nosnippet>173</a> /// from this socket.
<a href=#174 id=174 data-nosnippet>174</a> ///
<a href=#175 id=175 data-nosnippet>175</a> /// # Notes
<a href=#176 id=176 data-nosnippet>176</a> ///
<a href=#177 id=177 data-nosnippet>177</a> /// On Windows make sure the stream is connected before calling this method,
<a href=#178 id=178 data-nosnippet>178</a> /// by receiving an (writable) event. Trying to set `ttl` on an
<a href=#179 id=179 data-nosnippet>179</a> /// unconnected `TcpStream` is unspecified behavior.
<a href=#180 id=180 data-nosnippet>180</a> </span><span class="kw">pub fn </span>set_ttl(<span class="kw-2">&amp;</span><span class="self">self</span>, ttl: u32) -&gt; io::Result&lt;()&gt; {
<a href=#181 id=181 data-nosnippet>181</a> <span class="self">self</span>.inner.set_ttl(ttl)
<a href=#182 id=182 data-nosnippet>182</a> }
<a href=#183 id=183 data-nosnippet>183</a>
<a href=#184 id=184 data-nosnippet>184</a> <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket.
<a href=#185 id=185 data-nosnippet>185</a> ///
<a href=#186 id=186 data-nosnippet>186</a> /// For more information about this option, see [`set_ttl`][link].
<a href=#187 id=187 data-nosnippet>187</a> ///
<a href=#188 id=188 data-nosnippet>188</a> /// # Notes
<a href=#189 id=189 data-nosnippet>189</a> ///
<a href=#190 id=190 data-nosnippet>190</a> /// On Windows make sure the stream is connected before calling this method,
<a href=#191 id=191 data-nosnippet>191</a> /// by receiving an (writable) event. Trying to get `ttl` on an
<a href=#192 id=192 data-nosnippet>192</a> /// unconnected `TcpStream` is unspecified behavior.
<a href=#193 id=193 data-nosnippet>193</a> ///
<a href=#194 id=194 data-nosnippet>194</a> /// [link]: #method.set_ttl
<a href=#195 id=195 data-nosnippet>195</a> </span><span class="kw">pub fn </span>ttl(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;u32&gt; {
<a href=#196 id=196 data-nosnippet>196</a> <span class="self">self</span>.inner.ttl()
<a href=#197 id=197 data-nosnippet>197</a> }
<a href=#198 id=198 data-nosnippet>198</a>
<a href=#199 id=199 data-nosnippet>199</a> <span class="doccomment">/// Get the value of the `SO_ERROR` option on this socket.
<a href=#200 id=200 data-nosnippet>200</a> ///
<a href=#201 id=201 data-nosnippet>201</a> /// This will retrieve the stored error in the underlying socket, clearing
<a href=#202 id=202 data-nosnippet>202</a> /// the field in the process. This can be useful for checking errors between
<a href=#203 id=203 data-nosnippet>203</a> /// calls.
<a href=#204 id=204 data-nosnippet>204</a> </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;io::Error&gt;&gt; {
<a href=#205 id=205 data-nosnippet>205</a> <span class="self">self</span>.inner.take_error()
<a href=#206 id=206 data-nosnippet>206</a> }
<a href=#207 id=207 data-nosnippet>207</a>
<a href=#208 id=208 data-nosnippet>208</a> <span class="doccomment">/// Receives data on the socket from the remote address to which it is
<a href=#209 id=209 data-nosnippet>209</a> /// connected, without removing that data from the queue. On success,
<a href=#210 id=210 data-nosnippet>210</a> /// returns the number of bytes peeked.
<a href=#211 id=211 data-nosnippet>211</a> ///
<a href=#212 id=212 data-nosnippet>212</a> /// Successive calls return the same data. This is accomplished by passing
<a href=#213 id=213 data-nosnippet>213</a> /// `MSG_PEEK` as a flag to the underlying recv system call.
<a href=#214 id=214 data-nosnippet>214</a> </span><span class="kw">pub fn </span>peek(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#215 id=215 data-nosnippet>215</a> <span class="comment">// Need to re-register if `peek` returns `WouldBlock`
<a href=#216 id=216 data-nosnippet>216</a> // to ensure the socket will receive more events once it is ready again.
<a href=#217 id=217 data-nosnippet>217</a> </span><span class="self">self</span>.inner.do_io(|inner| inner.peek(buf))
<a href=#218 id=218 data-nosnippet>218</a> }
<a href=#219 id=219 data-nosnippet>219</a>
<a href=#220 id=220 data-nosnippet>220</a> <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events
<a href=#221 id=221 data-nosnippet>221</a> /// if it hits a [`WouldBlock`] error.
<a href=#222 id=222 data-nosnippet>222</a> ///
<a href=#223 id=223 data-nosnippet>223</a> /// # Notes
<a href=#224 id=224 data-nosnippet>224</a> ///
<a href=#225 id=225 data-nosnippet>225</a> /// This method is required to be called for **all** I/O operations to
<a href=#226 id=226 data-nosnippet>226</a> /// ensure the user will receive events once the socket is ready again after
<a href=#227 id=227 data-nosnippet>227</a> /// returning a [`WouldBlock`] error.
<a href=#228 id=228 data-nosnippet>228</a> ///
<a href=#229 id=229 data-nosnippet>229</a> /// [`WouldBlock`]: io::ErrorKind::WouldBlock
<a href=#230 id=230 data-nosnippet>230</a> ///
<a href=#231 id=231 data-nosnippet>231</a> /// # Examples
<a href=#232 id=232 data-nosnippet>232</a> ///
<a href=#233 id=233 data-nosnippet>233</a> </span><span class="attr">#[cfg_attr(unix, doc = <span class="string">"```no_run"</span>)]
<a href=#234 id=234 data-nosnippet>234</a> #[cfg_attr(windows, doc = <span class="string">"```ignore"</span>)]
<a href=#235 id=235 data-nosnippet>235</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#236 id=236 data-nosnippet>236</a> /// #
<a href=#237 id=237 data-nosnippet>237</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#238 id=238 data-nosnippet>238</a> /// use std::io;
<a href=#239 id=239 data-nosnippet>239</a> /// #[cfg(any(unix, target_os = "wasi"))]
<a href=#240 id=240 data-nosnippet>240</a> /// use std::os::fd::AsRawFd;
<a href=#241 id=241 data-nosnippet>241</a> /// #[cfg(windows)]
<a href=#242 id=242 data-nosnippet>242</a> /// use std::os::windows::io::AsRawSocket;
<a href=#243 id=243 data-nosnippet>243</a> /// use mio::net::TcpStream;
<a href=#244 id=244 data-nosnippet>244</a> ///
<a href=#245 id=245 data-nosnippet>245</a> /// let address = "127.0.0.1:8080".parse().unwrap();
<a href=#246 id=246 data-nosnippet>246</a> /// let stream = TcpStream::connect(address)?;
<a href=#247 id=247 data-nosnippet>247</a> ///
<a href=#248 id=248 data-nosnippet>248</a> /// // Wait until the stream is readable...
<a href=#249 id=249 data-nosnippet>249</a> ///
<a href=#250 id=250 data-nosnippet>250</a> /// // Read from the stream using a direct libc call, of course the
<a href=#251 id=251 data-nosnippet>251</a> /// // `io::Read` implementation would be easier to use.
<a href=#252 id=252 data-nosnippet>252</a> /// let mut buf = [0; 512];
<a href=#253 id=253 data-nosnippet>253</a> /// let n = stream.try_io(|| {
<a href=#254 id=254 data-nosnippet>254</a> /// let buf_ptr = &amp;mut buf as *mut _ as *mut _;
<a href=#255 id=255 data-nosnippet>255</a> /// #[cfg(unix)]
<a href=#256 id=256 data-nosnippet>256</a> /// let res = unsafe { libc::recv(stream.as_raw_fd(), buf_ptr, buf.len(), 0) };
<a href=#257 id=257 data-nosnippet>257</a> /// #[cfg(windows)]
<a href=#258 id=258 data-nosnippet>258</a> /// let res = unsafe { libc::recvfrom(stream.as_raw_socket() as usize, buf_ptr, buf.len() as i32, 0, std::ptr::null_mut(), std::ptr::null_mut()) };
<a href=#259 id=259 data-nosnippet>259</a> /// if res != -1 {
<a href=#260 id=260 data-nosnippet>260</a> /// Ok(res as usize)
<a href=#261 id=261 data-nosnippet>261</a> /// } else {
<a href=#262 id=262 data-nosnippet>262</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure
<a href=#263 id=263 data-nosnippet>263</a> /// // should return `WouldBlock` error.
<a href=#264 id=264 data-nosnippet>264</a> /// Err(io::Error::last_os_error())
<a href=#265 id=265 data-nosnippet>265</a> /// }
<a href=#266 id=266 data-nosnippet>266</a> /// })?;
<a href=#267 id=267 data-nosnippet>267</a> /// eprintln!("read {} bytes", n);
<a href=#268 id=268 data-nosnippet>268</a> /// # Ok(())
<a href=#269 id=269 data-nosnippet>269</a> /// # }
<a href=#270 id=270 data-nosnippet>270</a> /// ```
<a href=#271 id=271 data-nosnippet>271</a> </span><span class="kw">pub fn </span>try_io&lt;F, T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; io::Result&lt;T&gt;
<a href=#272 id=272 data-nosnippet>272</a> <span class="kw">where
<a href=#273 id=273 data-nosnippet>273</a> </span>F: FnOnce() -&gt; io::Result&lt;T&gt;,
<a href=#274 id=274 data-nosnippet>274</a> {
<a href=#275 id=275 data-nosnippet>275</a> <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f())
<a href=#276 id=276 data-nosnippet>276</a> }
<a href=#277 id=277 data-nosnippet>277</a>}
<a href=#278 id=278 data-nosnippet>278</a>
<a href=#279 id=279 data-nosnippet>279</a><span class="kw">impl </span>Read <span class="kw">for </span>TcpStream {
<a href=#280 id=280 data-nosnippet>280</a> <span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#281 id=281 data-nosnippet>281</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read(buf))
<a href=#282 id=282 data-nosnippet>282</a> }
<a href=#283 id=283 data-nosnippet>283</a>
<a href=#284 id=284 data-nosnippet>284</a> <span class="kw">fn </span>read_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;mut </span>[IoSliceMut&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#285 id=285 data-nosnippet>285</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read_vectored(bufs))
<a href=#286 id=286 data-nosnippet>286</a> }
<a href=#287 id=287 data-nosnippet>287</a>}
<a href=#288 id=288 data-nosnippet>288</a>
<a href=#289 id=289 data-nosnippet>289</a><span class="kw">impl </span>Read <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">'_ </span>TcpStream {
<a href=#290 id=290 data-nosnippet>290</a> <span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#291 id=291 data-nosnippet>291</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read(buf))
<a href=#292 id=292 data-nosnippet>292</a> }
<a href=#293 id=293 data-nosnippet>293</a>
<a href=#294 id=294 data-nosnippet>294</a> <span class="kw">fn </span>read_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;mut </span>[IoSliceMut&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#295 id=295 data-nosnippet>295</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read_vectored(bufs))
<a href=#296 id=296 data-nosnippet>296</a> }
<a href=#297 id=297 data-nosnippet>297</a>}
<a href=#298 id=298 data-nosnippet>298</a>
<a href=#299 id=299 data-nosnippet>299</a><span class="kw">impl </span>Write <span class="kw">for </span>TcpStream {
<a href=#300 id=300 data-nosnippet>300</a> <span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#301 id=301 data-nosnippet>301</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write(buf))
<a href=#302 id=302 data-nosnippet>302</a> }
<a href=#303 id=303 data-nosnippet>303</a>
<a href=#304 id=304 data-nosnippet>304</a> <span class="kw">fn </span>write_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#305 id=305 data-nosnippet>305</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write_vectored(bufs))
<a href=#306 id=306 data-nosnippet>306</a> }
<a href=#307 id=307 data-nosnippet>307</a>
<a href=#308 id=308 data-nosnippet>308</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#309 id=309 data-nosnippet>309</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.flush())
<a href=#310 id=310 data-nosnippet>310</a> }
<a href=#311 id=311 data-nosnippet>311</a>}
<a href=#312 id=312 data-nosnippet>312</a>
<a href=#313 id=313 data-nosnippet>313</a><span class="kw">impl </span>Write <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">'_ </span>TcpStream {
<a href=#314 id=314 data-nosnippet>314</a> <span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#315 id=315 data-nosnippet>315</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write(buf))
<a href=#316 id=316 data-nosnippet>316</a> }
<a href=#317 id=317 data-nosnippet>317</a>
<a href=#318 id=318 data-nosnippet>318</a> <span class="kw">fn </span>write_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#319 id=319 data-nosnippet>319</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write_vectored(bufs))
<a href=#320 id=320 data-nosnippet>320</a> }
<a href=#321 id=321 data-nosnippet>321</a>
<a href=#322 id=322 data-nosnippet>322</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#323 id=323 data-nosnippet>323</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.flush())
<a href=#324 id=324 data-nosnippet>324</a> }
<a href=#325 id=325 data-nosnippet>325</a>}
<a href=#326 id=326 data-nosnippet>326</a>
<a href=#327 id=327 data-nosnippet>327</a><span class="kw">impl </span>event::Source <span class="kw">for </span>TcpStream {
<a href=#328 id=328 data-nosnippet>328</a> <span class="kw">fn </span>register(
<a href=#329 id=329 data-nosnippet>329</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#330 id=330 data-nosnippet>330</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#331 id=331 data-nosnippet>331</a> token: Token,
<a href=#332 id=332 data-nosnippet>332</a> interests: Interest,
<a href=#333 id=333 data-nosnippet>333</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#334 id=334 data-nosnippet>334</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#335 id=335 data-nosnippet>335</a> }
<a href=#336 id=336 data-nosnippet>336</a>
<a href=#337 id=337 data-nosnippet>337</a> <span class="kw">fn </span>reregister(
<a href=#338 id=338 data-nosnippet>338</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#339 id=339 data-nosnippet>339</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#340 id=340 data-nosnippet>340</a> token: Token,
<a href=#341 id=341 data-nosnippet>341</a> interests: Interest,
<a href=#342 id=342 data-nosnippet>342</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#343 id=343 data-nosnippet>343</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#344 id=344 data-nosnippet>344</a> }
<a href=#345 id=345 data-nosnippet>345</a>
<a href=#346 id=346 data-nosnippet>346</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#347 id=347 data-nosnippet>347</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#348 id=348 data-nosnippet>348</a> }
<a href=#349 id=349 data-nosnippet>349</a>}
<a href=#350 id=350 data-nosnippet>350</a>
<a href=#351 id=351 data-nosnippet>351</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TcpStream {
<a href=#352 id=352 data-nosnippet>352</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#353 id=353 data-nosnippet>353</a> <span class="self">self</span>.inner.fmt(f)
<a href=#354 id=354 data-nosnippet>354</a> }
<a href=#355 id=355 data-nosnippet>355</a>}
<a href=#356 id=356 data-nosnippet>356</a>
<a href=#357 id=357 data-nosnippet>357</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#358 id=358 data-nosnippet>358</a></span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>TcpStream {
<a href=#359 id=359 data-nosnippet>359</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#360 id=360 data-nosnippet>360</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#361 id=361 data-nosnippet>361</a> }
<a href=#362 id=362 data-nosnippet>362</a>}
<a href=#363 id=363 data-nosnippet>363</a>
<a href=#364 id=364 data-nosnippet>364</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#365 id=365 data-nosnippet>365</a></span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>TcpStream {
<a href=#366 id=366 data-nosnippet>366</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#367 id=367 data-nosnippet>367</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#368 id=368 data-nosnippet>368</a> }
<a href=#369 id=369 data-nosnippet>369</a>}
<a href=#370 id=370 data-nosnippet>370</a>
<a href=#371 id=371 data-nosnippet>371</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#372 id=372 data-nosnippet>372</a></span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>TcpStream {
<a href=#373 id=373 data-nosnippet>373</a> <span class="doccomment">/// Converts a `RawFd` to a `TcpStream`.
<a href=#374 id=374 data-nosnippet>374</a> ///
<a href=#375 id=375 data-nosnippet>375</a> /// # Notes
<a href=#376 id=376 data-nosnippet>376</a> ///
<a href=#377 id=377 data-nosnippet>377</a> /// The caller is responsible for ensuring that the socket is in
<a href=#378 id=378 data-nosnippet>378</a> /// non-blocking mode.
<a href=#379 id=379 data-nosnippet>379</a> </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; TcpStream {
<a href=#380 id=380 data-nosnippet>380</a> TcpStream::from_std(FromRawFd::from_raw_fd(fd))
<a href=#381 id=381 data-nosnippet>381</a> }
<a href=#382 id=382 data-nosnippet>382</a>}
<a href=#383 id=383 data-nosnippet>383</a>
<a href=#384 id=384 data-nosnippet>384</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#385 id=385 data-nosnippet>385</a></span><span class="kw">impl </span>From&lt;TcpStream&gt; <span class="kw">for </span>OwnedFd {
<a href=#386 id=386 data-nosnippet>386</a> <span class="kw">fn </span>from(tcp_stream: TcpStream) -&gt; <span class="self">Self </span>{
<a href=#387 id=387 data-nosnippet>387</a> tcp_stream.inner.into_inner().into()
<a href=#388 id=388 data-nosnippet>388</a> }
<a href=#389 id=389 data-nosnippet>389</a>}
<a href=#390 id=390 data-nosnippet>390</a>
<a href=#391 id=391 data-nosnippet>391</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#392 id=392 data-nosnippet>392</a></span><span class="kw">impl </span>AsFd <span class="kw">for </span>TcpStream {
<a href=#393 id=393 data-nosnippet>393</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#394 id=394 data-nosnippet>394</a> <span class="self">self</span>.inner.as_fd()
<a href=#395 id=395 data-nosnippet>395</a> }
<a href=#396 id=396 data-nosnippet>396</a>}
<a href=#397 id=397 data-nosnippet>397</a>
<a href=#398 id=398 data-nosnippet>398</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#399 id=399 data-nosnippet>399</a></span><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>TcpStream {
<a href=#400 id=400 data-nosnippet>400</a> <span class="doccomment">/// Converts a `RawFd` to a `TcpStream`.
<a href=#401 id=401 data-nosnippet>401</a> ///
<a href=#402 id=402 data-nosnippet>402</a> /// # Notes
<a href=#403 id=403 data-nosnippet>403</a> ///
<a href=#404 id=404 data-nosnippet>404</a> /// The caller is responsible for ensuring that the socket is in
<a href=#405 id=405 data-nosnippet>405</a> /// non-blocking mode.
<a href=#406 id=406 data-nosnippet>406</a> </span><span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#407 id=407 data-nosnippet>407</a> TcpStream::from_std(From::from(fd))
<a href=#408 id=408 data-nosnippet>408</a> }
<a href=#409 id=409 data-nosnippet>409</a>}
<a href=#410 id=410 data-nosnippet>410</a>
<a href=#411 id=411 data-nosnippet>411</a><span class="attr">#[cfg(windows)]
<a href=#412 id=412 data-nosnippet>412</a></span><span class="kw">impl </span>IntoRawSocket <span class="kw">for </span>TcpStream {
<a href=#413 id=413 data-nosnippet>413</a> <span class="kw">fn </span>into_raw_socket(<span class="self">self</span>) -&gt; RawSocket {
<a href=#414 id=414 data-nosnippet>414</a> <span class="self">self</span>.inner.into_inner().into_raw_socket()
<a href=#415 id=415 data-nosnippet>415</a> }
<a href=#416 id=416 data-nosnippet>416</a>}
<a href=#417 id=417 data-nosnippet>417</a>
<a href=#418 id=418 data-nosnippet>418</a><span class="attr">#[cfg(windows)]
<a href=#419 id=419 data-nosnippet>419</a></span><span class="kw">impl </span>AsRawSocket <span class="kw">for </span>TcpStream {
<a href=#420 id=420 data-nosnippet>420</a> <span class="kw">fn </span>as_raw_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawSocket {
<a href=#421 id=421 data-nosnippet>421</a> <span class="self">self</span>.inner.as_raw_socket()
<a href=#422 id=422 data-nosnippet>422</a> }
<a href=#423 id=423 data-nosnippet>423</a>}
<a href=#424 id=424 data-nosnippet>424</a>
<a href=#425 id=425 data-nosnippet>425</a><span class="attr">#[cfg(windows)]
<a href=#426 id=426 data-nosnippet>426</a></span><span class="kw">impl </span>FromRawSocket <span class="kw">for </span>TcpStream {
<a href=#427 id=427 data-nosnippet>427</a> <span class="doccomment">/// Converts a `RawSocket` to a `TcpStream`.
<a href=#428 id=428 data-nosnippet>428</a> ///
<a href=#429 id=429 data-nosnippet>429</a> /// # Notes
<a href=#430 id=430 data-nosnippet>430</a> ///
<a href=#431 id=431 data-nosnippet>431</a> /// The caller is responsible for ensuring that the socket is in
<a href=#432 id=432 data-nosnippet>432</a> /// non-blocking mode.
<a href=#433 id=433 data-nosnippet>433</a> </span><span class="kw">unsafe fn </span>from_raw_socket(socket: RawSocket) -&gt; TcpStream {
<a href=#434 id=434 data-nosnippet>434</a> TcpStream::from_std(FromRawSocket::from_raw_socket(socket))
<a href=#435 id=435 data-nosnippet>435</a> }
<a href=#436 id=436 data-nosnippet>436</a>}
<a href=#437 id=437 data-nosnippet>437</a>
<a href=#438 id=438 data-nosnippet>438</a><span class="attr">#[cfg(windows)]
<a href=#439 id=439 data-nosnippet>439</a></span><span class="kw">impl </span>From&lt;TcpStream&gt; <span class="kw">for </span>OwnedSocket {
<a href=#440 id=440 data-nosnippet>440</a> <span class="kw">fn </span>from(tcp_stream: TcpStream) -&gt; <span class="self">Self </span>{
<a href=#441 id=441 data-nosnippet>441</a> tcp_stream.inner.into_inner().into()
<a href=#442 id=442 data-nosnippet>442</a> }
<a href=#443 id=443 data-nosnippet>443</a>}
<a href=#444 id=444 data-nosnippet>444</a>
<a href=#445 id=445 data-nosnippet>445</a><span class="attr">#[cfg(windows)]
<a href=#446 id=446 data-nosnippet>446</a></span><span class="kw">impl </span>AsSocket <span class="kw">for </span>TcpStream {
<a href=#447 id=447 data-nosnippet>447</a> <span class="kw">fn </span>as_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedSocket&lt;<span class="lifetime">'_</span>&gt; {
<a href=#448 id=448 data-nosnippet>448</a> <span class="self">self</span>.inner.as_socket()
<a href=#449 id=449 data-nosnippet>449</a> }
<a href=#450 id=450 data-nosnippet>450</a>}
<a href=#451 id=451 data-nosnippet>451</a>
<a href=#452 id=452 data-nosnippet>452</a><span class="attr">#[cfg(windows)]
<a href=#453 id=453 data-nosnippet>453</a></span><span class="kw">impl </span>From&lt;OwnedSocket&gt; <span class="kw">for </span>TcpStream {
<a href=#454 id=454 data-nosnippet>454</a> <span class="doccomment">/// Converts a `RawSocket` to a `TcpStream`.
<a href=#455 id=455 data-nosnippet>455</a> ///
<a href=#456 id=456 data-nosnippet>456</a> /// # Notes
<a href=#457 id=457 data-nosnippet>457</a> ///
<a href=#458 id=458 data-nosnippet>458</a> /// The caller is responsible for ensuring that the socket is in
<a href=#459 id=459 data-nosnippet>459</a> /// non-blocking mode.
<a href=#460 id=460 data-nosnippet>460</a> </span><span class="kw">fn </span>from(socket: OwnedSocket) -&gt; <span class="self">Self </span>{
<a href=#461 id=461 data-nosnippet>461</a> TcpStream::from_std(From::from(socket))
<a href=#462 id=462 data-nosnippet>462</a> }
<a href=#463 id=463 data-nosnippet>463</a>}
<a href=#464 id=464 data-nosnippet>464</a>
<a href=#465 id=465 data-nosnippet>465</a><span class="kw">impl </span>From&lt;TcpStream&gt; <span class="kw">for </span>net::TcpStream {
<a href=#466 id=466 data-nosnippet>466</a> <span class="kw">fn </span>from(stream: TcpStream) -&gt; <span class="self">Self </span>{
<a href=#467 id=467 data-nosnippet>467</a> <span class="comment">// Safety: This is safe since we are extracting the raw fd from a well-constructed
<a href=#468 id=468 data-nosnippet>468</a> // mio::net::TcpStream which ensures that we actually pass in a valid file
<a href=#469 id=469 data-nosnippet>469</a> // descriptor/socket
<a href=#470 id=470 data-nosnippet>470</a> </span><span class="kw">unsafe </span>{
<a href=#471 id=471 data-nosnippet>471</a> <span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#472 id=472 data-nosnippet>472</a> </span>{
<a href=#473 id=473 data-nosnippet>473</a> net::TcpStream::from_raw_fd(stream.into_raw_fd())
<a href=#474 id=474 data-nosnippet>474</a> }
<a href=#475 id=475 data-nosnippet>475</a> <span class="attr">#[cfg(windows)]
<a href=#476 id=476 data-nosnippet>476</a> </span>{
<a href=#477 id=477 data-nosnippet>477</a> net::TcpStream::from_raw_socket(stream.into_raw_socket())
<a href=#478 id=478 data-nosnippet>478</a> }
<a href=#479 id=479 data-nosnippet>479</a> }
<a href=#480 id=480 data-nosnippet>480</a> }
<a href=#481 id=481 data-nosnippet>481</a>}
</code></pre></div></section></main></body></html>
+774
View File
@@ -0,0 +1,774 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/udp.rs`."><title>udp.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/</div>udp.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Primitives for working with UDP.
<a href=#2 id=2 data-nosnippet>2</a>//!
<a href=#3 id=3 data-nosnippet>3</a>//! The types provided in this module are non-blocking by default and are
<a href=#4 id=4 data-nosnippet>4</a>//! designed to be portable across all supported Mio platforms. As long as the
<a href=#5 id=5 data-nosnippet>5</a>//! [portability guidelines] are followed, the behavior should be identical no
<a href=#6 id=6 data-nosnippet>6</a>//! matter the target platform.
<a href=#7 id=7 data-nosnippet>7</a>//!
<a href=#8 id=8 data-nosnippet>8</a>//! [portability guidelines]: ../struct.Poll.html#portability
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a></span><span class="kw">use </span>std::net::{Ipv4Addr, Ipv6Addr, SocketAddr};
<a href=#11 id=11 data-nosnippet>11</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"wasi"</span>))]
<a href=#12 id=12 data-nosnippet>12</a></span><span class="kw">use </span>std::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#13 id=13 data-nosnippet>13</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#14 id=14 data-nosnippet>14</a>// can use `std::os::fd` and be merged with the above.
<a href=#15 id=15 data-nosnippet>15</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">use </span>std::os::hermit::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#17 id=17 data-nosnippet>17</a><span class="attr">#[cfg(windows)]
<a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">use </span>std::os::windows::io::{
<a href=#19 id=19 data-nosnippet>19</a> AsRawSocket, AsSocket, BorrowedSocket, FromRawSocket, IntoRawSocket, OwnedSocket, RawSocket,
<a href=#20 id=20 data-nosnippet>20</a>};
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>std::{fmt, io, net};
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use crate</span>::{event, sys, Interest, Registry, Token};
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a><span class="doccomment">/// A User Datagram Protocol socket.
<a href=#27 id=27 data-nosnippet>27</a>///
<a href=#28 id=28 data-nosnippet>28</a>/// This is an implementation of a bound UDP socket. This supports both IPv4 and
<a href=#29 id=29 data-nosnippet>29</a>/// IPv6 addresses, and there is no corresponding notion of a server because UDP
<a href=#30 id=30 data-nosnippet>30</a>/// is a datagram protocol.
<a href=#31 id=31 data-nosnippet>31</a>///
<a href=#32 id=32 data-nosnippet>32</a>/// # Examples
<a href=#33 id=33 data-nosnippet>33</a>///
<a href=#34 id=34 data-nosnippet>34</a></span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#35 id=35 data-nosnippet>35</a>#[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#36 id=36 data-nosnippet>36</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#37 id=37 data-nosnippet>37</a>/// #
<a href=#38 id=38 data-nosnippet>38</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#39 id=39 data-nosnippet>39</a>/// // An Echo program:
<a href=#40 id=40 data-nosnippet>40</a>/// // SENDER -&gt; sends a message.
<a href=#41 id=41 data-nosnippet>41</a>/// // ECHOER -&gt; listens and prints the message received.
<a href=#42 id=42 data-nosnippet>42</a>///
<a href=#43 id=43 data-nosnippet>43</a>/// use mio::net::UdpSocket;
<a href=#44 id=44 data-nosnippet>44</a>/// use mio::{Events, Interest, Poll, Token};
<a href=#45 id=45 data-nosnippet>45</a>/// use std::time::Duration;
<a href=#46 id=46 data-nosnippet>46</a>///
<a href=#47 id=47 data-nosnippet>47</a>/// const SENDER: Token = Token(0);
<a href=#48 id=48 data-nosnippet>48</a>/// const ECHOER: Token = Token(1);
<a href=#49 id=49 data-nosnippet>49</a>///
<a href=#50 id=50 data-nosnippet>50</a>/// // This operation will fail if the address is in use, so we select different ports for each
<a href=#51 id=51 data-nosnippet>51</a>/// // socket.
<a href=#52 id=52 data-nosnippet>52</a>/// let mut sender_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#53 id=53 data-nosnippet>53</a>/// let mut echoer_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#54 id=54 data-nosnippet>54</a>///
<a href=#55 id=55 data-nosnippet>55</a>/// // If we do not use connect here, SENDER and ECHOER would need to call send_to and recv_from
<a href=#56 id=56 data-nosnippet>56</a>/// // respectively.
<a href=#57 id=57 data-nosnippet>57</a>/// sender_socket.connect(echoer_socket.local_addr()?)?;
<a href=#58 id=58 data-nosnippet>58</a>///
<a href=#59 id=59 data-nosnippet>59</a>/// // We need a Poll to check if SENDER is ready to be written into, and if ECHOER is ready to be
<a href=#60 id=60 data-nosnippet>60</a>/// // read from.
<a href=#61 id=61 data-nosnippet>61</a>/// let mut poll = Poll::new()?;
<a href=#62 id=62 data-nosnippet>62</a>///
<a href=#63 id=63 data-nosnippet>63</a>/// // We register our sockets here so that we can check if they are ready to be written/read.
<a href=#64 id=64 data-nosnippet>64</a>/// poll.registry().register(&amp;mut sender_socket, SENDER, Interest::WRITABLE)?;
<a href=#65 id=65 data-nosnippet>65</a>/// poll.registry().register(&amp;mut echoer_socket, ECHOER, Interest::READABLE)?;
<a href=#66 id=66 data-nosnippet>66</a>///
<a href=#67 id=67 data-nosnippet>67</a>/// let msg_to_send = [9; 9];
<a href=#68 id=68 data-nosnippet>68</a>/// let mut buffer = [0; 9];
<a href=#69 id=69 data-nosnippet>69</a>///
<a href=#70 id=70 data-nosnippet>70</a>/// let mut events = Events::with_capacity(128);
<a href=#71 id=71 data-nosnippet>71</a>/// loop {
<a href=#72 id=72 data-nosnippet>72</a>/// poll.poll(&amp;mut events, Some(Duration::from_millis(100)))?;
<a href=#73 id=73 data-nosnippet>73</a>/// for event in events.iter() {
<a href=#74 id=74 data-nosnippet>74</a>/// match event.token() {
<a href=#75 id=75 data-nosnippet>75</a>/// // Our SENDER is ready to be written into.
<a href=#76 id=76 data-nosnippet>76</a>/// SENDER =&gt; {
<a href=#77 id=77 data-nosnippet>77</a>/// let bytes_sent = sender_socket.send(&amp;msg_to_send)?;
<a href=#78 id=78 data-nosnippet>78</a>/// assert_eq!(bytes_sent, 9);
<a href=#79 id=79 data-nosnippet>79</a>/// println!("sent {:?} -&gt; {:?} bytes", msg_to_send, bytes_sent);
<a href=#80 id=80 data-nosnippet>80</a>/// },
<a href=#81 id=81 data-nosnippet>81</a>/// // Our ECHOER is ready to be read from.
<a href=#82 id=82 data-nosnippet>82</a>/// ECHOER =&gt; {
<a href=#83 id=83 data-nosnippet>83</a>/// let num_recv = echoer_socket.recv(&amp;mut buffer)?;
<a href=#84 id=84 data-nosnippet>84</a>/// println!("echo {:?} -&gt; {:?}", buffer, num_recv);
<a href=#85 id=85 data-nosnippet>85</a>/// buffer = [0; 9];
<a href=#86 id=86 data-nosnippet>86</a>/// # _ = buffer; // Silence unused assignment warning.
<a href=#87 id=87 data-nosnippet>87</a>/// # return Ok(());
<a href=#88 id=88 data-nosnippet>88</a>/// }
<a href=#89 id=89 data-nosnippet>89</a>/// _ =&gt; unreachable!()
<a href=#90 id=90 data-nosnippet>90</a>/// }
<a href=#91 id=91 data-nosnippet>91</a>/// }
<a href=#92 id=92 data-nosnippet>92</a>/// }
<a href=#93 id=93 data-nosnippet>93</a>/// # }
<a href=#94 id=94 data-nosnippet>94</a>/// ```
<a href=#95 id=95 data-nosnippet>95</a></span><span class="kw">pub struct </span>UdpSocket {
<a href=#96 id=96 data-nosnippet>96</a> inner: IoSource&lt;net::UdpSocket&gt;,
<a href=#97 id=97 data-nosnippet>97</a>}
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a><span class="kw">impl </span>UdpSocket {
<a href=#100 id=100 data-nosnippet>100</a> <span class="doccomment">/// Creates a UDP socket from the given address.
<a href=#101 id=101 data-nosnippet>101</a> ///
<a href=#102 id=102 data-nosnippet>102</a> /// # Examples
<a href=#103 id=103 data-nosnippet>103</a> ///
<a href=#104 id=104 data-nosnippet>104</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#105 id=105 data-nosnippet>105</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#107 id=107 data-nosnippet>107</a> /// #
<a href=#108 id=108 data-nosnippet>108</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#109 id=109 data-nosnippet>109</a> /// use mio::net::UdpSocket;
<a href=#110 id=110 data-nosnippet>110</a> ///
<a href=#111 id=111 data-nosnippet>111</a> /// // We must bind it to an open address.
<a href=#112 id=112 data-nosnippet>112</a> /// let socket = match UdpSocket::bind("127.0.0.1:0".parse()?) {
<a href=#113 id=113 data-nosnippet>113</a> /// Ok(new_socket) =&gt; new_socket,
<a href=#114 id=114 data-nosnippet>114</a> /// Err(fail) =&gt; {
<a href=#115 id=115 data-nosnippet>115</a> /// // We panic! here, but you could try to bind it again on another address.
<a href=#116 id=116 data-nosnippet>116</a> /// panic!("Failed to bind socket. {:?}", fail);
<a href=#117 id=117 data-nosnippet>117</a> /// }
<a href=#118 id=118 data-nosnippet>118</a> /// };
<a href=#119 id=119 data-nosnippet>119</a> ///
<a href=#120 id=120 data-nosnippet>120</a> /// // Our socket was created, but we should not use it before checking it's readiness.
<a href=#121 id=121 data-nosnippet>121</a> /// # drop(socket); // Silence unused variable warning.
<a href=#122 id=122 data-nosnippet>122</a> /// # Ok(())
<a href=#123 id=123 data-nosnippet>123</a> /// # }
<a href=#124 id=124 data-nosnippet>124</a> /// ```
<a href=#125 id=125 data-nosnippet>125</a> </span><span class="kw">pub fn </span>bind(addr: SocketAddr) -&gt; io::Result&lt;UdpSocket&gt; {
<a href=#126 id=126 data-nosnippet>126</a> sys::udp::bind(addr).map(UdpSocket::from_std)
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a>
<a href=#129 id=129 data-nosnippet>129</a> <span class="doccomment">/// Creates a new `UdpSocket` from a standard `net::UdpSocket`.
<a href=#130 id=130 data-nosnippet>130</a> ///
<a href=#131 id=131 data-nosnippet>131</a> /// This function is intended to be used to wrap a UDP socket from the
<a href=#132 id=132 data-nosnippet>132</a> /// standard library in the Mio equivalent. The conversion assumes nothing
<a href=#133 id=133 data-nosnippet>133</a> /// about the underlying socket; it is left up to the user to set it in
<a href=#134 id=134 data-nosnippet>134</a> /// non-blocking mode.
<a href=#135 id=135 data-nosnippet>135</a> </span><span class="kw">pub fn </span>from_std(socket: net::UdpSocket) -&gt; UdpSocket {
<a href=#136 id=136 data-nosnippet>136</a> UdpSocket {
<a href=#137 id=137 data-nosnippet>137</a> inner: IoSource::new(socket),
<a href=#138 id=138 data-nosnippet>138</a> }
<a href=#139 id=139 data-nosnippet>139</a> }
<a href=#140 id=140 data-nosnippet>140</a>
<a href=#141 id=141 data-nosnippet>141</a> <span class="doccomment">/// Returns the socket address that this socket was created from.
<a href=#142 id=142 data-nosnippet>142</a> ///
<a href=#143 id=143 data-nosnippet>143</a> /// # Examples
<a href=#144 id=144 data-nosnippet>144</a> ///
<a href=#145 id=145 data-nosnippet>145</a> </span><span class="comment">// This assertion is almost, but not quite, universal. It fails on
<a href=#146 id=146 data-nosnippet>146</a> // shared-IP FreeBSD jails. It's hard for mio to know whether we're jailed,
<a href=#147 id=147 data-nosnippet>147</a> // so simply disable the test on FreeBSD.
<a href=#148 id=148 data-nosnippet>148</a> </span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, not(target_os = <span class="string">"freebsd"</span>)), doc = <span class="string">"```"</span>)]
<a href=#149 id=149 data-nosnippet>149</a> #[cfg_attr(
<a href=#150 id=150 data-nosnippet>150</a> any(not(feature = <span class="string">"os-poll"</span>), target_os = <span class="string">"freebsd"</span>),
<a href=#151 id=151 data-nosnippet>151</a> doc = <span class="string">"```ignore"
<a href=#152 id=152 data-nosnippet>152</a> </span>)]
<a href=#153 id=153 data-nosnippet>153</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#154 id=154 data-nosnippet>154</a> /// #
<a href=#155 id=155 data-nosnippet>155</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#156 id=156 data-nosnippet>156</a> /// use mio::net::UdpSocket;
<a href=#157 id=157 data-nosnippet>157</a> ///
<a href=#158 id=158 data-nosnippet>158</a> /// let addr = "127.0.0.1:0".parse()?;
<a href=#159 id=159 data-nosnippet>159</a> /// let socket = UdpSocket::bind(addr)?;
<a href=#160 id=160 data-nosnippet>160</a> /// assert_eq!(socket.local_addr()?.ip(), addr.ip());
<a href=#161 id=161 data-nosnippet>161</a> /// # Ok(())
<a href=#162 id=162 data-nosnippet>162</a> /// # }
<a href=#163 id=163 data-nosnippet>163</a> /// ```
<a href=#164 id=164 data-nosnippet>164</a> </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#165 id=165 data-nosnippet>165</a> <span class="self">self</span>.inner.local_addr()
<a href=#166 id=166 data-nosnippet>166</a> }
<a href=#167 id=167 data-nosnippet>167</a>
<a href=#168 id=168 data-nosnippet>168</a> <span class="doccomment">/// Returns the socket address of the remote peer this socket was connected to.
<a href=#169 id=169 data-nosnippet>169</a> ///
<a href=#170 id=170 data-nosnippet>170</a> /// # Examples
<a href=#171 id=171 data-nosnippet>171</a> ///
<a href=#172 id=172 data-nosnippet>172</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#173 id=173 data-nosnippet>173</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#174 id=174 data-nosnippet>174</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#175 id=175 data-nosnippet>175</a> /// #
<a href=#176 id=176 data-nosnippet>176</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#177 id=177 data-nosnippet>177</a> /// use mio::net::UdpSocket;
<a href=#178 id=178 data-nosnippet>178</a> ///
<a href=#179 id=179 data-nosnippet>179</a> /// let addr = "127.0.0.1:0".parse()?;
<a href=#180 id=180 data-nosnippet>180</a> /// let peer_addr = "127.0.0.1:11100".parse()?;
<a href=#181 id=181 data-nosnippet>181</a> /// let socket = UdpSocket::bind(addr)?;
<a href=#182 id=182 data-nosnippet>182</a> /// socket.connect(peer_addr)?;
<a href=#183 id=183 data-nosnippet>183</a> /// assert_eq!(socket.peer_addr()?.ip(), peer_addr.ip());
<a href=#184 id=184 data-nosnippet>184</a> /// # Ok(())
<a href=#185 id=185 data-nosnippet>185</a> /// # }
<a href=#186 id=186 data-nosnippet>186</a> /// ```
<a href=#187 id=187 data-nosnippet>187</a> </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#188 id=188 data-nosnippet>188</a> <span class="self">self</span>.inner.peer_addr()
<a href=#189 id=189 data-nosnippet>189</a> }
<a href=#190 id=190 data-nosnippet>190</a>
<a href=#191 id=191 data-nosnippet>191</a> <span class="doccomment">/// Sends data on the socket to the given address. On success, returns the
<a href=#192 id=192 data-nosnippet>192</a> /// number of bytes written.
<a href=#193 id=193 data-nosnippet>193</a> ///
<a href=#194 id=194 data-nosnippet>194</a> /// Address type can be any implementor of `ToSocketAddrs` trait. See its
<a href=#195 id=195 data-nosnippet>195</a> /// documentation for concrete examples.
<a href=#196 id=196 data-nosnippet>196</a> ///
<a href=#197 id=197 data-nosnippet>197</a> /// # Examples
<a href=#198 id=198 data-nosnippet>198</a> ///
<a href=#199 id=199 data-nosnippet>199</a> /// ```no_run
<a href=#200 id=200 data-nosnippet>200</a> /// # use std::error::Error;
<a href=#201 id=201 data-nosnippet>201</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#202 id=202 data-nosnippet>202</a> /// use mio::net::UdpSocket;
<a href=#203 id=203 data-nosnippet>203</a> ///
<a href=#204 id=204 data-nosnippet>204</a> /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#205 id=205 data-nosnippet>205</a> ///
<a href=#206 id=206 data-nosnippet>206</a> /// // We must check if the socket is writable before calling send_to,
<a href=#207 id=207 data-nosnippet>207</a> /// // or we could run into a WouldBlock error.
<a href=#208 id=208 data-nosnippet>208</a> ///
<a href=#209 id=209 data-nosnippet>209</a> /// let bytes_sent = socket.send_to(&amp;[9; 9], "127.0.0.1:11100".parse()?)?;
<a href=#210 id=210 data-nosnippet>210</a> /// assert_eq!(bytes_sent, 9);
<a href=#211 id=211 data-nosnippet>211</a> /// #
<a href=#212 id=212 data-nosnippet>212</a> /// # Ok(())
<a href=#213 id=213 data-nosnippet>213</a> /// # }
<a href=#214 id=214 data-nosnippet>214</a> /// ```
<a href=#215 id=215 data-nosnippet>215</a> </span><span class="kw">pub fn </span>send_to(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8], target: SocketAddr) -&gt; io::Result&lt;usize&gt; {
<a href=#216 id=216 data-nosnippet>216</a> <span class="self">self</span>.inner.do_io(|inner| inner.send_to(buf, target))
<a href=#217 id=217 data-nosnippet>217</a> }
<a href=#218 id=218 data-nosnippet>218</a>
<a href=#219 id=219 data-nosnippet>219</a> <span class="doccomment">/// Receives data from the socket. On success, returns the number of bytes
<a href=#220 id=220 data-nosnippet>220</a> /// read and the address from whence the data came.
<a href=#221 id=221 data-nosnippet>221</a> ///
<a href=#222 id=222 data-nosnippet>222</a> /// # Notes
<a href=#223 id=223 data-nosnippet>223</a> ///
<a href=#224 id=224 data-nosnippet>224</a> /// On Windows, if the data is larger than the buffer specified, the buffer
<a href=#225 id=225 data-nosnippet>225</a> /// is filled with the first part of the data, and recv_from returns the error
<a href=#226 id=226 data-nosnippet>226</a> /// WSAEMSGSIZE(10040). The excess data is lost.
<a href=#227 id=227 data-nosnippet>227</a> /// Make sure to always use a sufficiently large buffer to hold the
<a href=#228 id=228 data-nosnippet>228</a> /// maximum UDP packet size, which can be up to 65536 bytes in size.
<a href=#229 id=229 data-nosnippet>229</a> ///
<a href=#230 id=230 data-nosnippet>230</a> /// # Examples
<a href=#231 id=231 data-nosnippet>231</a> ///
<a href=#232 id=232 data-nosnippet>232</a> /// ```no_run
<a href=#233 id=233 data-nosnippet>233</a> /// # use std::error::Error;
<a href=#234 id=234 data-nosnippet>234</a> /// #
<a href=#235 id=235 data-nosnippet>235</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#236 id=236 data-nosnippet>236</a> /// use mio::net::UdpSocket;
<a href=#237 id=237 data-nosnippet>237</a> ///
<a href=#238 id=238 data-nosnippet>238</a> /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#239 id=239 data-nosnippet>239</a> ///
<a href=#240 id=240 data-nosnippet>240</a> /// // We must check if the socket is readable before calling recv_from,
<a href=#241 id=241 data-nosnippet>241</a> /// // or we could run into a WouldBlock error.
<a href=#242 id=242 data-nosnippet>242</a> ///
<a href=#243 id=243 data-nosnippet>243</a> /// let mut buf = [0; 9];
<a href=#244 id=244 data-nosnippet>244</a> /// let (num_recv, from_addr) = socket.recv_from(&amp;mut buf)?;
<a href=#245 id=245 data-nosnippet>245</a> /// println!("Received {:?} -&gt; {:?} bytes from {:?}", buf, num_recv, from_addr);
<a href=#246 id=246 data-nosnippet>246</a> /// #
<a href=#247 id=247 data-nosnippet>247</a> /// # Ok(())
<a href=#248 id=248 data-nosnippet>248</a> /// # }
<a href=#249 id=249 data-nosnippet>249</a> /// ```
<a href=#250 id=250 data-nosnippet>250</a> </span><span class="kw">pub fn </span>recv_from(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;(usize, SocketAddr)&gt; {
<a href=#251 id=251 data-nosnippet>251</a> <span class="self">self</span>.inner.do_io(|inner| inner.recv_from(buf))
<a href=#252 id=252 data-nosnippet>252</a> }
<a href=#253 id=253 data-nosnippet>253</a>
<a href=#254 id=254 data-nosnippet>254</a> <span class="doccomment">/// Receives data from the socket, without removing it from the input queue.
<a href=#255 id=255 data-nosnippet>255</a> /// On success, returns the number of bytes read and the address from whence
<a href=#256 id=256 data-nosnippet>256</a> /// the data came.
<a href=#257 id=257 data-nosnippet>257</a> ///
<a href=#258 id=258 data-nosnippet>258</a> /// # Notes
<a href=#259 id=259 data-nosnippet>259</a> ///
<a href=#260 id=260 data-nosnippet>260</a> /// On Windows, if the data is larger than the buffer specified, the buffer
<a href=#261 id=261 data-nosnippet>261</a> /// is filled with the first part of the data, and peek_from returns the error
<a href=#262 id=262 data-nosnippet>262</a> /// WSAEMSGSIZE(10040). The excess data is lost.
<a href=#263 id=263 data-nosnippet>263</a> /// Make sure to always use a sufficiently large buffer to hold the
<a href=#264 id=264 data-nosnippet>264</a> /// maximum UDP packet size, which can be up to 65536 bytes in size.
<a href=#265 id=265 data-nosnippet>265</a> ///
<a href=#266 id=266 data-nosnippet>266</a> /// # Examples
<a href=#267 id=267 data-nosnippet>267</a> ///
<a href=#268 id=268 data-nosnippet>268</a> /// ```no_run
<a href=#269 id=269 data-nosnippet>269</a> /// # use std::error::Error;
<a href=#270 id=270 data-nosnippet>270</a> /// #
<a href=#271 id=271 data-nosnippet>271</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#272 id=272 data-nosnippet>272</a> /// use mio::net::UdpSocket;
<a href=#273 id=273 data-nosnippet>273</a> ///
<a href=#274 id=274 data-nosnippet>274</a> /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#275 id=275 data-nosnippet>275</a> ///
<a href=#276 id=276 data-nosnippet>276</a> /// // We must check if the socket is readable before calling recv_from,
<a href=#277 id=277 data-nosnippet>277</a> /// // or we could run into a WouldBlock error.
<a href=#278 id=278 data-nosnippet>278</a> ///
<a href=#279 id=279 data-nosnippet>279</a> /// let mut buf = [0; 9];
<a href=#280 id=280 data-nosnippet>280</a> /// let (num_recv, from_addr) = socket.peek_from(&amp;mut buf)?;
<a href=#281 id=281 data-nosnippet>281</a> /// println!("Received {:?} -&gt; {:?} bytes from {:?}", buf, num_recv, from_addr);
<a href=#282 id=282 data-nosnippet>282</a> /// #
<a href=#283 id=283 data-nosnippet>283</a> /// # Ok(())
<a href=#284 id=284 data-nosnippet>284</a> /// # }
<a href=#285 id=285 data-nosnippet>285</a> /// ```
<a href=#286 id=286 data-nosnippet>286</a> </span><span class="kw">pub fn </span>peek_from(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;(usize, SocketAddr)&gt; {
<a href=#287 id=287 data-nosnippet>287</a> <span class="self">self</span>.inner.do_io(|inner| inner.peek_from(buf))
<a href=#288 id=288 data-nosnippet>288</a> }
<a href=#289 id=289 data-nosnippet>289</a>
<a href=#290 id=290 data-nosnippet>290</a> <span class="doccomment">/// Sends data on the socket to the address previously bound via connect(). On success,
<a href=#291 id=291 data-nosnippet>291</a> /// returns the number of bytes written.
<a href=#292 id=292 data-nosnippet>292</a> </span><span class="kw">pub fn </span>send(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#293 id=293 data-nosnippet>293</a> <span class="self">self</span>.inner.do_io(|inner| inner.send(buf))
<a href=#294 id=294 data-nosnippet>294</a> }
<a href=#295 id=295 data-nosnippet>295</a>
<a href=#296 id=296 data-nosnippet>296</a> <span class="doccomment">/// Receives data from the socket previously bound with connect(). On success, returns
<a href=#297 id=297 data-nosnippet>297</a> /// the number of bytes read.
<a href=#298 id=298 data-nosnippet>298</a> ///
<a href=#299 id=299 data-nosnippet>299</a> /// # Notes
<a href=#300 id=300 data-nosnippet>300</a> ///
<a href=#301 id=301 data-nosnippet>301</a> /// On Windows, if the data is larger than the buffer specified, the buffer
<a href=#302 id=302 data-nosnippet>302</a> /// is filled with the first part of the data, and recv returns the error
<a href=#303 id=303 data-nosnippet>303</a> /// WSAEMSGSIZE(10040). The excess data is lost.
<a href=#304 id=304 data-nosnippet>304</a> /// Make sure to always use a sufficiently large buffer to hold the
<a href=#305 id=305 data-nosnippet>305</a> /// maximum UDP packet size, which can be up to 65536 bytes in size.
<a href=#306 id=306 data-nosnippet>306</a> </span><span class="kw">pub fn </span>recv(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#307 id=307 data-nosnippet>307</a> <span class="self">self</span>.inner.do_io(|inner| inner.recv(buf))
<a href=#308 id=308 data-nosnippet>308</a> }
<a href=#309 id=309 data-nosnippet>309</a>
<a href=#310 id=310 data-nosnippet>310</a> <span class="doccomment">/// Receives data from the socket, without removing it from the input queue.
<a href=#311 id=311 data-nosnippet>311</a> /// On success, returns the number of bytes read.
<a href=#312 id=312 data-nosnippet>312</a> ///
<a href=#313 id=313 data-nosnippet>313</a> /// # Notes
<a href=#314 id=314 data-nosnippet>314</a> ///
<a href=#315 id=315 data-nosnippet>315</a> /// On Windows, if the data is larger than the buffer specified, the buffer
<a href=#316 id=316 data-nosnippet>316</a> /// is filled with the first part of the data, and peek returns the error
<a href=#317 id=317 data-nosnippet>317</a> /// WSAEMSGSIZE(10040). The excess data is lost.
<a href=#318 id=318 data-nosnippet>318</a> /// Make sure to always use a sufficiently large buffer to hold the
<a href=#319 id=319 data-nosnippet>319</a> /// maximum UDP packet size, which can be up to 65536 bytes in size.
<a href=#320 id=320 data-nosnippet>320</a> </span><span class="kw">pub fn </span>peek(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#321 id=321 data-nosnippet>321</a> <span class="self">self</span>.inner.do_io(|inner| inner.peek(buf))
<a href=#322 id=322 data-nosnippet>322</a> }
<a href=#323 id=323 data-nosnippet>323</a>
<a href=#324 id=324 data-nosnippet>324</a> <span class="doccomment">/// Connects the UDP socket setting the default destination for `send()`
<a href=#325 id=325 data-nosnippet>325</a> /// and limiting packets that are read via `recv` from the address specified
<a href=#326 id=326 data-nosnippet>326</a> /// in `addr`.
<a href=#327 id=327 data-nosnippet>327</a> ///
<a href=#328 id=328 data-nosnippet>328</a> /// This may return a `WouldBlock` in which case the socket connection
<a href=#329 id=329 data-nosnippet>329</a> /// cannot be completed immediately, it usually means there are insufficient
<a href=#330 id=330 data-nosnippet>330</a> /// entries in the routing cache.
<a href=#331 id=331 data-nosnippet>331</a> </span><span class="kw">pub fn </span>connect(<span class="kw-2">&amp;</span><span class="self">self</span>, addr: SocketAddr) -&gt; io::Result&lt;()&gt; {
<a href=#332 id=332 data-nosnippet>332</a> <span class="self">self</span>.inner.connect(addr)
<a href=#333 id=333 data-nosnippet>333</a> }
<a href=#334 id=334 data-nosnippet>334</a>
<a href=#335 id=335 data-nosnippet>335</a> <span class="doccomment">/// Sets the value of the `SO_BROADCAST` option for this socket.
<a href=#336 id=336 data-nosnippet>336</a> ///
<a href=#337 id=337 data-nosnippet>337</a> /// When enabled, this socket is allowed to send packets to a broadcast
<a href=#338 id=338 data-nosnippet>338</a> /// address.
<a href=#339 id=339 data-nosnippet>339</a> ///
<a href=#340 id=340 data-nosnippet>340</a> /// # Examples
<a href=#341 id=341 data-nosnippet>341</a> ///
<a href=#342 id=342 data-nosnippet>342</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#343 id=343 data-nosnippet>343</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#344 id=344 data-nosnippet>344</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#345 id=345 data-nosnippet>345</a> /// #
<a href=#346 id=346 data-nosnippet>346</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#347 id=347 data-nosnippet>347</a> /// use mio::net::UdpSocket;
<a href=#348 id=348 data-nosnippet>348</a> ///
<a href=#349 id=349 data-nosnippet>349</a> /// let broadcast_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#350 id=350 data-nosnippet>350</a> /// if broadcast_socket.broadcast()? == false {
<a href=#351 id=351 data-nosnippet>351</a> /// broadcast_socket.set_broadcast(true)?;
<a href=#352 id=352 data-nosnippet>352</a> /// }
<a href=#353 id=353 data-nosnippet>353</a> ///
<a href=#354 id=354 data-nosnippet>354</a> /// assert_eq!(broadcast_socket.broadcast()?, true);
<a href=#355 id=355 data-nosnippet>355</a> /// #
<a href=#356 id=356 data-nosnippet>356</a> /// # Ok(())
<a href=#357 id=357 data-nosnippet>357</a> /// # }
<a href=#358 id=358 data-nosnippet>358</a> /// ```
<a href=#359 id=359 data-nosnippet>359</a> </span><span class="kw">pub fn </span>set_broadcast(<span class="kw-2">&amp;</span><span class="self">self</span>, on: bool) -&gt; io::Result&lt;()&gt; {
<a href=#360 id=360 data-nosnippet>360</a> <span class="self">self</span>.inner.set_broadcast(on)
<a href=#361 id=361 data-nosnippet>361</a> }
<a href=#362 id=362 data-nosnippet>362</a>
<a href=#363 id=363 data-nosnippet>363</a> <span class="doccomment">/// Gets the value of the `SO_BROADCAST` option for this socket.
<a href=#364 id=364 data-nosnippet>364</a> ///
<a href=#365 id=365 data-nosnippet>365</a> /// For more information about this option, see
<a href=#366 id=366 data-nosnippet>366</a> /// [`set_broadcast`][link].
<a href=#367 id=367 data-nosnippet>367</a> ///
<a href=#368 id=368 data-nosnippet>368</a> /// [link]: #method.set_broadcast
<a href=#369 id=369 data-nosnippet>369</a> ///
<a href=#370 id=370 data-nosnippet>370</a> /// # Examples
<a href=#371 id=371 data-nosnippet>371</a> ///
<a href=#372 id=372 data-nosnippet>372</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#373 id=373 data-nosnippet>373</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#374 id=374 data-nosnippet>374</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#375 id=375 data-nosnippet>375</a> /// #
<a href=#376 id=376 data-nosnippet>376</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#377 id=377 data-nosnippet>377</a> /// use mio::net::UdpSocket;
<a href=#378 id=378 data-nosnippet>378</a> ///
<a href=#379 id=379 data-nosnippet>379</a> /// let broadcast_socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#380 id=380 data-nosnippet>380</a> /// assert_eq!(broadcast_socket.broadcast()?, false);
<a href=#381 id=381 data-nosnippet>381</a> /// #
<a href=#382 id=382 data-nosnippet>382</a> /// # Ok(())
<a href=#383 id=383 data-nosnippet>383</a> /// # }
<a href=#384 id=384 data-nosnippet>384</a> /// ```
<a href=#385 id=385 data-nosnippet>385</a> </span><span class="kw">pub fn </span>broadcast(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;bool&gt; {
<a href=#386 id=386 data-nosnippet>386</a> <span class="self">self</span>.inner.broadcast()
<a href=#387 id=387 data-nosnippet>387</a> }
<a href=#388 id=388 data-nosnippet>388</a>
<a href=#389 id=389 data-nosnippet>389</a> <span class="doccomment">/// Sets the value of the `IP_MULTICAST_LOOP` option for this socket.
<a href=#390 id=390 data-nosnippet>390</a> ///
<a href=#391 id=391 data-nosnippet>391</a> /// If enabled, multicast packets will be looped back to the local socket.
<a href=#392 id=392 data-nosnippet>392</a> /// Note that this may not have any affect on IPv6 sockets.
<a href=#393 id=393 data-nosnippet>393</a> </span><span class="kw">pub fn </span>set_multicast_loop_v4(<span class="kw-2">&amp;</span><span class="self">self</span>, on: bool) -&gt; io::Result&lt;()&gt; {
<a href=#394 id=394 data-nosnippet>394</a> <span class="self">self</span>.inner.set_multicast_loop_v4(on)
<a href=#395 id=395 data-nosnippet>395</a> }
<a href=#396 id=396 data-nosnippet>396</a>
<a href=#397 id=397 data-nosnippet>397</a> <span class="doccomment">/// Gets the value of the `IP_MULTICAST_LOOP` option for this socket.
<a href=#398 id=398 data-nosnippet>398</a> ///
<a href=#399 id=399 data-nosnippet>399</a> /// For more information about this option, see
<a href=#400 id=400 data-nosnippet>400</a> /// [`set_multicast_loop_v4`][link].
<a href=#401 id=401 data-nosnippet>401</a> ///
<a href=#402 id=402 data-nosnippet>402</a> /// [link]: #method.set_multicast_loop_v4
<a href=#403 id=403 data-nosnippet>403</a> </span><span class="kw">pub fn </span>multicast_loop_v4(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;bool&gt; {
<a href=#404 id=404 data-nosnippet>404</a> <span class="self">self</span>.inner.multicast_loop_v4()
<a href=#405 id=405 data-nosnippet>405</a> }
<a href=#406 id=406 data-nosnippet>406</a>
<a href=#407 id=407 data-nosnippet>407</a> <span class="doccomment">/// Sets the value of the `IP_MULTICAST_TTL` option for this socket.
<a href=#408 id=408 data-nosnippet>408</a> ///
<a href=#409 id=409 data-nosnippet>409</a> /// Indicates the time-to-live value of outgoing multicast packets for
<a href=#410 id=410 data-nosnippet>410</a> /// this socket. The default value is 1 which means that multicast packets
<a href=#411 id=411 data-nosnippet>411</a> /// don't leave the local network unless explicitly requested.
<a href=#412 id=412 data-nosnippet>412</a> ///
<a href=#413 id=413 data-nosnippet>413</a> /// Note that this may not have any affect on IPv6 sockets.
<a href=#414 id=414 data-nosnippet>414</a> </span><span class="kw">pub fn </span>set_multicast_ttl_v4(<span class="kw-2">&amp;</span><span class="self">self</span>, ttl: u32) -&gt; io::Result&lt;()&gt; {
<a href=#415 id=415 data-nosnippet>415</a> <span class="self">self</span>.inner.set_multicast_ttl_v4(ttl)
<a href=#416 id=416 data-nosnippet>416</a> }
<a href=#417 id=417 data-nosnippet>417</a>
<a href=#418 id=418 data-nosnippet>418</a> <span class="doccomment">/// Gets the value of the `IP_MULTICAST_TTL` option for this socket.
<a href=#419 id=419 data-nosnippet>419</a> ///
<a href=#420 id=420 data-nosnippet>420</a> /// For more information about this option, see
<a href=#421 id=421 data-nosnippet>421</a> /// [`set_multicast_ttl_v4`][link].
<a href=#422 id=422 data-nosnippet>422</a> ///
<a href=#423 id=423 data-nosnippet>423</a> /// [link]: #method.set_multicast_ttl_v4
<a href=#424 id=424 data-nosnippet>424</a> </span><span class="kw">pub fn </span>multicast_ttl_v4(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;u32&gt; {
<a href=#425 id=425 data-nosnippet>425</a> <span class="self">self</span>.inner.multicast_ttl_v4()
<a href=#426 id=426 data-nosnippet>426</a> }
<a href=#427 id=427 data-nosnippet>427</a>
<a href=#428 id=428 data-nosnippet>428</a> <span class="doccomment">/// Sets the value of the `IPV6_MULTICAST_LOOP` option for this socket.
<a href=#429 id=429 data-nosnippet>429</a> ///
<a href=#430 id=430 data-nosnippet>430</a> /// Controls whether this socket sees the multicast packets it sends itself.
<a href=#431 id=431 data-nosnippet>431</a> /// Note that this may not have any affect on IPv4 sockets.
<a href=#432 id=432 data-nosnippet>432</a> </span><span class="kw">pub fn </span>set_multicast_loop_v6(<span class="kw-2">&amp;</span><span class="self">self</span>, on: bool) -&gt; io::Result&lt;()&gt; {
<a href=#433 id=433 data-nosnippet>433</a> <span class="self">self</span>.inner.set_multicast_loop_v6(on)
<a href=#434 id=434 data-nosnippet>434</a> }
<a href=#435 id=435 data-nosnippet>435</a>
<a href=#436 id=436 data-nosnippet>436</a> <span class="doccomment">/// Gets the value of the `IPV6_MULTICAST_LOOP` option for this socket.
<a href=#437 id=437 data-nosnippet>437</a> ///
<a href=#438 id=438 data-nosnippet>438</a> /// For more information about this option, see
<a href=#439 id=439 data-nosnippet>439</a> /// [`set_multicast_loop_v6`][link].
<a href=#440 id=440 data-nosnippet>440</a> ///
<a href=#441 id=441 data-nosnippet>441</a> /// [link]: #method.set_multicast_loop_v6
<a href=#442 id=442 data-nosnippet>442</a> </span><span class="kw">pub fn </span>multicast_loop_v6(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;bool&gt; {
<a href=#443 id=443 data-nosnippet>443</a> <span class="self">self</span>.inner.multicast_loop_v6()
<a href=#444 id=444 data-nosnippet>444</a> }
<a href=#445 id=445 data-nosnippet>445</a>
<a href=#446 id=446 data-nosnippet>446</a> <span class="doccomment">/// Sets the value for the `IP_TTL` option on this socket.
<a href=#447 id=447 data-nosnippet>447</a> ///
<a href=#448 id=448 data-nosnippet>448</a> /// This value sets the time-to-live field that is used in every packet sent
<a href=#449 id=449 data-nosnippet>449</a> /// from this socket.
<a href=#450 id=450 data-nosnippet>450</a> ///
<a href=#451 id=451 data-nosnippet>451</a> /// # Examples
<a href=#452 id=452 data-nosnippet>452</a> ///
<a href=#453 id=453 data-nosnippet>453</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#454 id=454 data-nosnippet>454</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#455 id=455 data-nosnippet>455</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#456 id=456 data-nosnippet>456</a> /// #
<a href=#457 id=457 data-nosnippet>457</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#458 id=458 data-nosnippet>458</a> /// use mio::net::UdpSocket;
<a href=#459 id=459 data-nosnippet>459</a> ///
<a href=#460 id=460 data-nosnippet>460</a> /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#461 id=461 data-nosnippet>461</a> /// if socket.ttl()? &lt; 255 {
<a href=#462 id=462 data-nosnippet>462</a> /// socket.set_ttl(255)?;
<a href=#463 id=463 data-nosnippet>463</a> /// }
<a href=#464 id=464 data-nosnippet>464</a> ///
<a href=#465 id=465 data-nosnippet>465</a> /// assert_eq!(socket.ttl()?, 255);
<a href=#466 id=466 data-nosnippet>466</a> /// #
<a href=#467 id=467 data-nosnippet>467</a> /// # Ok(())
<a href=#468 id=468 data-nosnippet>468</a> /// # }
<a href=#469 id=469 data-nosnippet>469</a> /// ```
<a href=#470 id=470 data-nosnippet>470</a> </span><span class="kw">pub fn </span>set_ttl(<span class="kw-2">&amp;</span><span class="self">self</span>, ttl: u32) -&gt; io::Result&lt;()&gt; {
<a href=#471 id=471 data-nosnippet>471</a> <span class="self">self</span>.inner.set_ttl(ttl)
<a href=#472 id=472 data-nosnippet>472</a> }
<a href=#473 id=473 data-nosnippet>473</a>
<a href=#474 id=474 data-nosnippet>474</a> <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket.
<a href=#475 id=475 data-nosnippet>475</a> ///
<a href=#476 id=476 data-nosnippet>476</a> /// For more information about this option, see [`set_ttl`][link].
<a href=#477 id=477 data-nosnippet>477</a> ///
<a href=#478 id=478 data-nosnippet>478</a> /// [link]: #method.set_ttl
<a href=#479 id=479 data-nosnippet>479</a> ///
<a href=#480 id=480 data-nosnippet>480</a> /// # Examples
<a href=#481 id=481 data-nosnippet>481</a> ///
<a href=#482 id=482 data-nosnippet>482</a> </span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#483 id=483 data-nosnippet>483</a> #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#484 id=484 data-nosnippet>484</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#485 id=485 data-nosnippet>485</a> /// #
<a href=#486 id=486 data-nosnippet>486</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#487 id=487 data-nosnippet>487</a> /// use mio::net::UdpSocket;
<a href=#488 id=488 data-nosnippet>488</a> ///
<a href=#489 id=489 data-nosnippet>489</a> /// let socket = UdpSocket::bind("127.0.0.1:0".parse()?)?;
<a href=#490 id=490 data-nosnippet>490</a> /// socket.set_ttl(255)?;
<a href=#491 id=491 data-nosnippet>491</a> ///
<a href=#492 id=492 data-nosnippet>492</a> /// assert_eq!(socket.ttl()?, 255);
<a href=#493 id=493 data-nosnippet>493</a> /// #
<a href=#494 id=494 data-nosnippet>494</a> /// # Ok(())
<a href=#495 id=495 data-nosnippet>495</a> /// # }
<a href=#496 id=496 data-nosnippet>496</a> /// ```
<a href=#497 id=497 data-nosnippet>497</a> </span><span class="kw">pub fn </span>ttl(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;u32&gt; {
<a href=#498 id=498 data-nosnippet>498</a> <span class="self">self</span>.inner.ttl()
<a href=#499 id=499 data-nosnippet>499</a> }
<a href=#500 id=500 data-nosnippet>500</a>
<a href=#501 id=501 data-nosnippet>501</a> <span class="doccomment">/// Executes an operation of the `IP_ADD_MEMBERSHIP` type.
<a href=#502 id=502 data-nosnippet>502</a> ///
<a href=#503 id=503 data-nosnippet>503</a> /// This function specifies a new multicast group for this socket to join.
<a href=#504 id=504 data-nosnippet>504</a> /// The address must be a valid multicast address, and `interface` is the
<a href=#505 id=505 data-nosnippet>505</a> /// address of the local interface with which the system should join the
<a href=#506 id=506 data-nosnippet>506</a> /// multicast group. If it's equal to `INADDR_ANY` then an appropriate
<a href=#507 id=507 data-nosnippet>507</a> /// interface is chosen by the system.
<a href=#508 id=508 data-nosnippet>508</a> </span><span class="attr">#[allow(clippy::trivially_copy_pass_by_ref)]
<a href=#509 id=509 data-nosnippet>509</a> </span><span class="kw">pub fn </span>join_multicast_v4(<span class="kw-2">&amp;</span><span class="self">self</span>, multiaddr: <span class="kw-2">&amp;</span>Ipv4Addr, interface: <span class="kw-2">&amp;</span>Ipv4Addr) -&gt; io::Result&lt;()&gt; {
<a href=#510 id=510 data-nosnippet>510</a> <span class="self">self</span>.inner.join_multicast_v4(multiaddr, interface)
<a href=#511 id=511 data-nosnippet>511</a> }
<a href=#512 id=512 data-nosnippet>512</a>
<a href=#513 id=513 data-nosnippet>513</a> <span class="doccomment">/// Executes an operation of the `IPV6_ADD_MEMBERSHIP` type.
<a href=#514 id=514 data-nosnippet>514</a> ///
<a href=#515 id=515 data-nosnippet>515</a> /// This function specifies a new multicast group for this socket to join.
<a href=#516 id=516 data-nosnippet>516</a> /// The address must be a valid multicast address, and `interface` is the
<a href=#517 id=517 data-nosnippet>517</a> /// index of the interface to join/leave (or 0 to indicate any interface).
<a href=#518 id=518 data-nosnippet>518</a> </span><span class="attr">#[allow(clippy::trivially_copy_pass_by_ref)]
<a href=#519 id=519 data-nosnippet>519</a> </span><span class="kw">pub fn </span>join_multicast_v6(<span class="kw-2">&amp;</span><span class="self">self</span>, multiaddr: <span class="kw-2">&amp;</span>Ipv6Addr, interface: u32) -&gt; io::Result&lt;()&gt; {
<a href=#520 id=520 data-nosnippet>520</a> <span class="self">self</span>.inner.join_multicast_v6(multiaddr, interface)
<a href=#521 id=521 data-nosnippet>521</a> }
<a href=#522 id=522 data-nosnippet>522</a>
<a href=#523 id=523 data-nosnippet>523</a> <span class="doccomment">/// Executes an operation of the `IP_DROP_MEMBERSHIP` type.
<a href=#524 id=524 data-nosnippet>524</a> ///
<a href=#525 id=525 data-nosnippet>525</a> /// For more information about this option, see
<a href=#526 id=526 data-nosnippet>526</a> /// [`join_multicast_v4`][link].
<a href=#527 id=527 data-nosnippet>527</a> ///
<a href=#528 id=528 data-nosnippet>528</a> /// [link]: #method.join_multicast_v4
<a href=#529 id=529 data-nosnippet>529</a> </span><span class="attr">#[allow(clippy::trivially_copy_pass_by_ref)]
<a href=#530 id=530 data-nosnippet>530</a> </span><span class="kw">pub fn </span>leave_multicast_v4(<span class="kw-2">&amp;</span><span class="self">self</span>, multiaddr: <span class="kw-2">&amp;</span>Ipv4Addr, interface: <span class="kw-2">&amp;</span>Ipv4Addr) -&gt; io::Result&lt;()&gt; {
<a href=#531 id=531 data-nosnippet>531</a> <span class="self">self</span>.inner.leave_multicast_v4(multiaddr, interface)
<a href=#532 id=532 data-nosnippet>532</a> }
<a href=#533 id=533 data-nosnippet>533</a>
<a href=#534 id=534 data-nosnippet>534</a> <span class="doccomment">/// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type.
<a href=#535 id=535 data-nosnippet>535</a> ///
<a href=#536 id=536 data-nosnippet>536</a> /// For more information about this option, see
<a href=#537 id=537 data-nosnippet>537</a> /// [`join_multicast_v6`][link].
<a href=#538 id=538 data-nosnippet>538</a> ///
<a href=#539 id=539 data-nosnippet>539</a> /// [link]: #method.join_multicast_v6
<a href=#540 id=540 data-nosnippet>540</a> </span><span class="attr">#[allow(clippy::trivially_copy_pass_by_ref)]
<a href=#541 id=541 data-nosnippet>541</a> </span><span class="kw">pub fn </span>leave_multicast_v6(<span class="kw-2">&amp;</span><span class="self">self</span>, multiaddr: <span class="kw-2">&amp;</span>Ipv6Addr, interface: u32) -&gt; io::Result&lt;()&gt; {
<a href=#542 id=542 data-nosnippet>542</a> <span class="self">self</span>.inner.leave_multicast_v6(multiaddr, interface)
<a href=#543 id=543 data-nosnippet>543</a> }
<a href=#544 id=544 data-nosnippet>544</a>
<a href=#545 id=545 data-nosnippet>545</a> <span class="doccomment">/// Get the value of the `IPV6_V6ONLY` option on this socket.
<a href=#546 id=546 data-nosnippet>546</a> </span><span class="attr">#[allow(clippy::trivially_copy_pass_by_ref)]
<a href=#547 id=547 data-nosnippet>547</a> </span><span class="kw">pub fn </span>only_v6(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;bool&gt; {
<a href=#548 id=548 data-nosnippet>548</a> sys::udp::only_v6(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#549 id=549 data-nosnippet>549</a> }
<a href=#550 id=550 data-nosnippet>550</a>
<a href=#551 id=551 data-nosnippet>551</a> <span class="doccomment">/// Get the value of the `SO_ERROR` option on this socket.
<a href=#552 id=552 data-nosnippet>552</a> ///
<a href=#553 id=553 data-nosnippet>553</a> /// This will retrieve the stored error in the underlying socket, clearing
<a href=#554 id=554 data-nosnippet>554</a> /// the field in the process. This can be useful for checking errors between
<a href=#555 id=555 data-nosnippet>555</a> /// calls.
<a href=#556 id=556 data-nosnippet>556</a> </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;io::Error&gt;&gt; {
<a href=#557 id=557 data-nosnippet>557</a> <span class="self">self</span>.inner.take_error()
<a href=#558 id=558 data-nosnippet>558</a> }
<a href=#559 id=559 data-nosnippet>559</a>
<a href=#560 id=560 data-nosnippet>560</a> <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events
<a href=#561 id=561 data-nosnippet>561</a> /// if it hits a [`WouldBlock`] error.
<a href=#562 id=562 data-nosnippet>562</a> ///
<a href=#563 id=563 data-nosnippet>563</a> /// # Notes
<a href=#564 id=564 data-nosnippet>564</a> ///
<a href=#565 id=565 data-nosnippet>565</a> /// This method is required to be called for **all** I/O operations to
<a href=#566 id=566 data-nosnippet>566</a> /// ensure the user will receive events once the socket is ready again after
<a href=#567 id=567 data-nosnippet>567</a> /// returning a [`WouldBlock`] error.
<a href=#568 id=568 data-nosnippet>568</a> ///
<a href=#569 id=569 data-nosnippet>569</a> /// [`WouldBlock`]: io::ErrorKind::WouldBlock
<a href=#570 id=570 data-nosnippet>570</a> ///
<a href=#571 id=571 data-nosnippet>571</a> /// # Examples
<a href=#572 id=572 data-nosnippet>572</a> ///
<a href=#573 id=573 data-nosnippet>573</a> </span><span class="attr">#[cfg_attr(unix, doc = <span class="string">"```no_run"</span>)]
<a href=#574 id=574 data-nosnippet>574</a> #[cfg_attr(windows, doc = <span class="string">"```ignore"</span>)]
<a href=#575 id=575 data-nosnippet>575</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#576 id=576 data-nosnippet>576</a> /// #
<a href=#577 id=577 data-nosnippet>577</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#578 id=578 data-nosnippet>578</a> /// use std::io;
<a href=#579 id=579 data-nosnippet>579</a> /// #[cfg(any(unix, target_os = "wasi"))]
<a href=#580 id=580 data-nosnippet>580</a> /// use std::os::fd::AsRawFd;
<a href=#581 id=581 data-nosnippet>581</a> /// #[cfg(windows)]
<a href=#582 id=582 data-nosnippet>582</a> /// use std::os::windows::io::AsRawSocket;
<a href=#583 id=583 data-nosnippet>583</a> /// use mio::net::UdpSocket;
<a href=#584 id=584 data-nosnippet>584</a> ///
<a href=#585 id=585 data-nosnippet>585</a> /// let address = "127.0.0.1:8080".parse().unwrap();
<a href=#586 id=586 data-nosnippet>586</a> /// let dgram = UdpSocket::bind(address)?;
<a href=#587 id=587 data-nosnippet>587</a> ///
<a href=#588 id=588 data-nosnippet>588</a> /// // Wait until the dgram is readable...
<a href=#589 id=589 data-nosnippet>589</a> ///
<a href=#590 id=590 data-nosnippet>590</a> /// // Read from the dgram using a direct libc call, of course the
<a href=#591 id=591 data-nosnippet>591</a> /// // `io::Read` implementation would be easier to use.
<a href=#592 id=592 data-nosnippet>592</a> /// let mut buf = [0; 512];
<a href=#593 id=593 data-nosnippet>593</a> /// let n = dgram.try_io(|| {
<a href=#594 id=594 data-nosnippet>594</a> /// let buf_ptr = &amp;mut buf as *mut _ as *mut _;
<a href=#595 id=595 data-nosnippet>595</a> /// #[cfg(unix)]
<a href=#596 id=596 data-nosnippet>596</a> /// let res = unsafe { libc::recv(dgram.as_raw_fd(), buf_ptr, buf.len(), 0) };
<a href=#597 id=597 data-nosnippet>597</a> /// #[cfg(windows)]
<a href=#598 id=598 data-nosnippet>598</a> /// let res = unsafe { libc::recvfrom(dgram.as_raw_socket() as usize, buf_ptr, buf.len() as i32, 0, std::ptr::null_mut(), std::ptr::null_mut()) };
<a href=#599 id=599 data-nosnippet>599</a> /// if res != -1 {
<a href=#600 id=600 data-nosnippet>600</a> /// Ok(res as usize)
<a href=#601 id=601 data-nosnippet>601</a> /// } else {
<a href=#602 id=602 data-nosnippet>602</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure
<a href=#603 id=603 data-nosnippet>603</a> /// // should return `WouldBlock` error.
<a href=#604 id=604 data-nosnippet>604</a> /// Err(io::Error::last_os_error())
<a href=#605 id=605 data-nosnippet>605</a> /// }
<a href=#606 id=606 data-nosnippet>606</a> /// })?;
<a href=#607 id=607 data-nosnippet>607</a> /// eprintln!("read {} bytes", n);
<a href=#608 id=608 data-nosnippet>608</a> /// # Ok(())
<a href=#609 id=609 data-nosnippet>609</a> /// # }
<a href=#610 id=610 data-nosnippet>610</a> /// ```
<a href=#611 id=611 data-nosnippet>611</a> </span><span class="kw">pub fn </span>try_io&lt;F, T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; io::Result&lt;T&gt;
<a href=#612 id=612 data-nosnippet>612</a> <span class="kw">where
<a href=#613 id=613 data-nosnippet>613</a> </span>F: FnOnce() -&gt; io::Result&lt;T&gt;,
<a href=#614 id=614 data-nosnippet>614</a> {
<a href=#615 id=615 data-nosnippet>615</a> <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f())
<a href=#616 id=616 data-nosnippet>616</a> }
<a href=#617 id=617 data-nosnippet>617</a>}
<a href=#618 id=618 data-nosnippet>618</a>
<a href=#619 id=619 data-nosnippet>619</a><span class="kw">impl </span>event::Source <span class="kw">for </span>UdpSocket {
<a href=#620 id=620 data-nosnippet>620</a> <span class="kw">fn </span>register(
<a href=#621 id=621 data-nosnippet>621</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#622 id=622 data-nosnippet>622</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#623 id=623 data-nosnippet>623</a> token: Token,
<a href=#624 id=624 data-nosnippet>624</a> interests: Interest,
<a href=#625 id=625 data-nosnippet>625</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#626 id=626 data-nosnippet>626</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#627 id=627 data-nosnippet>627</a> }
<a href=#628 id=628 data-nosnippet>628</a>
<a href=#629 id=629 data-nosnippet>629</a> <span class="kw">fn </span>reregister(
<a href=#630 id=630 data-nosnippet>630</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#631 id=631 data-nosnippet>631</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#632 id=632 data-nosnippet>632</a> token: Token,
<a href=#633 id=633 data-nosnippet>633</a> interests: Interest,
<a href=#634 id=634 data-nosnippet>634</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#635 id=635 data-nosnippet>635</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#636 id=636 data-nosnippet>636</a> }
<a href=#637 id=637 data-nosnippet>637</a>
<a href=#638 id=638 data-nosnippet>638</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#639 id=639 data-nosnippet>639</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#640 id=640 data-nosnippet>640</a> }
<a href=#641 id=641 data-nosnippet>641</a>}
<a href=#642 id=642 data-nosnippet>642</a>
<a href=#643 id=643 data-nosnippet>643</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UdpSocket {
<a href=#644 id=644 data-nosnippet>644</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#645 id=645 data-nosnippet>645</a> <span class="self">self</span>.inner.fmt(f)
<a href=#646 id=646 data-nosnippet>646</a> }
<a href=#647 id=647 data-nosnippet>647</a>}
<a href=#648 id=648 data-nosnippet>648</a>
<a href=#649 id=649 data-nosnippet>649</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#650 id=650 data-nosnippet>650</a></span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>UdpSocket {
<a href=#651 id=651 data-nosnippet>651</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#652 id=652 data-nosnippet>652</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#653 id=653 data-nosnippet>653</a> }
<a href=#654 id=654 data-nosnippet>654</a>}
<a href=#655 id=655 data-nosnippet>655</a>
<a href=#656 id=656 data-nosnippet>656</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#657 id=657 data-nosnippet>657</a></span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>UdpSocket {
<a href=#658 id=658 data-nosnippet>658</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#659 id=659 data-nosnippet>659</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#660 id=660 data-nosnippet>660</a> }
<a href=#661 id=661 data-nosnippet>661</a>}
<a href=#662 id=662 data-nosnippet>662</a>
<a href=#663 id=663 data-nosnippet>663</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#664 id=664 data-nosnippet>664</a></span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>UdpSocket {
<a href=#665 id=665 data-nosnippet>665</a> <span class="doccomment">/// Converts a `RawFd` to a `UdpSocket`.
<a href=#666 id=666 data-nosnippet>666</a> ///
<a href=#667 id=667 data-nosnippet>667</a> /// # Notes
<a href=#668 id=668 data-nosnippet>668</a> ///
<a href=#669 id=669 data-nosnippet>669</a> /// The caller is responsible for ensuring that the socket is in
<a href=#670 id=670 data-nosnippet>670</a> /// non-blocking mode.
<a href=#671 id=671 data-nosnippet>671</a> </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; UdpSocket {
<a href=#672 id=672 data-nosnippet>672</a> UdpSocket::from_std(FromRawFd::from_raw_fd(fd))
<a href=#673 id=673 data-nosnippet>673</a> }
<a href=#674 id=674 data-nosnippet>674</a>}
<a href=#675 id=675 data-nosnippet>675</a>
<a href=#676 id=676 data-nosnippet>676</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#677 id=677 data-nosnippet>677</a></span><span class="kw">impl </span>From&lt;UdpSocket&gt; <span class="kw">for </span>OwnedFd {
<a href=#678 id=678 data-nosnippet>678</a> <span class="kw">fn </span>from(udp_socket: UdpSocket) -&gt; <span class="self">Self </span>{
<a href=#679 id=679 data-nosnippet>679</a> udp_socket.inner.into_inner().into()
<a href=#680 id=680 data-nosnippet>680</a> }
<a href=#681 id=681 data-nosnippet>681</a>}
<a href=#682 id=682 data-nosnippet>682</a>
<a href=#683 id=683 data-nosnippet>683</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#684 id=684 data-nosnippet>684</a></span><span class="kw">impl </span>AsFd <span class="kw">for </span>UdpSocket {
<a href=#685 id=685 data-nosnippet>685</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#686 id=686 data-nosnippet>686</a> <span class="self">self</span>.inner.as_fd()
<a href=#687 id=687 data-nosnippet>687</a> }
<a href=#688 id=688 data-nosnippet>688</a>}
<a href=#689 id=689 data-nosnippet>689</a>
<a href=#690 id=690 data-nosnippet>690</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#691 id=691 data-nosnippet>691</a></span><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>UdpSocket {
<a href=#692 id=692 data-nosnippet>692</a> <span class="doccomment">/// Converts a `RawFd` to a `UdpSocket`.
<a href=#693 id=693 data-nosnippet>693</a> ///
<a href=#694 id=694 data-nosnippet>694</a> /// # Notes
<a href=#695 id=695 data-nosnippet>695</a> ///
<a href=#696 id=696 data-nosnippet>696</a> /// The caller is responsible for ensuring that the socket is in
<a href=#697 id=697 data-nosnippet>697</a> /// non-blocking mode.
<a href=#698 id=698 data-nosnippet>698</a> </span><span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#699 id=699 data-nosnippet>699</a> UdpSocket::from_std(From::from(fd))
<a href=#700 id=700 data-nosnippet>700</a> }
<a href=#701 id=701 data-nosnippet>701</a>}
<a href=#702 id=702 data-nosnippet>702</a>
<a href=#703 id=703 data-nosnippet>703</a><span class="attr">#[cfg(windows)]
<a href=#704 id=704 data-nosnippet>704</a></span><span class="kw">impl </span>IntoRawSocket <span class="kw">for </span>UdpSocket {
<a href=#705 id=705 data-nosnippet>705</a> <span class="kw">fn </span>into_raw_socket(<span class="self">self</span>) -&gt; RawSocket {
<a href=#706 id=706 data-nosnippet>706</a> <span class="self">self</span>.inner.into_inner().into_raw_socket()
<a href=#707 id=707 data-nosnippet>707</a> }
<a href=#708 id=708 data-nosnippet>708</a>}
<a href=#709 id=709 data-nosnippet>709</a>
<a href=#710 id=710 data-nosnippet>710</a><span class="attr">#[cfg(windows)]
<a href=#711 id=711 data-nosnippet>711</a></span><span class="kw">impl </span>AsRawSocket <span class="kw">for </span>UdpSocket {
<a href=#712 id=712 data-nosnippet>712</a> <span class="kw">fn </span>as_raw_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawSocket {
<a href=#713 id=713 data-nosnippet>713</a> <span class="self">self</span>.inner.as_raw_socket()
<a href=#714 id=714 data-nosnippet>714</a> }
<a href=#715 id=715 data-nosnippet>715</a>}
<a href=#716 id=716 data-nosnippet>716</a>
<a href=#717 id=717 data-nosnippet>717</a><span class="attr">#[cfg(windows)]
<a href=#718 id=718 data-nosnippet>718</a></span><span class="kw">impl </span>FromRawSocket <span class="kw">for </span>UdpSocket {
<a href=#719 id=719 data-nosnippet>719</a> <span class="doccomment">/// Converts a `RawSocket` to a `UdpSocket`.
<a href=#720 id=720 data-nosnippet>720</a> ///
<a href=#721 id=721 data-nosnippet>721</a> /// # Notes
<a href=#722 id=722 data-nosnippet>722</a> ///
<a href=#723 id=723 data-nosnippet>723</a> /// The caller is responsible for ensuring that the socket is in
<a href=#724 id=724 data-nosnippet>724</a> /// non-blocking mode.
<a href=#725 id=725 data-nosnippet>725</a> </span><span class="kw">unsafe fn </span>from_raw_socket(socket: RawSocket) -&gt; UdpSocket {
<a href=#726 id=726 data-nosnippet>726</a> UdpSocket::from_std(FromRawSocket::from_raw_socket(socket))
<a href=#727 id=727 data-nosnippet>727</a> }
<a href=#728 id=728 data-nosnippet>728</a>}
<a href=#729 id=729 data-nosnippet>729</a>
<a href=#730 id=730 data-nosnippet>730</a><span class="attr">#[cfg(windows)]
<a href=#731 id=731 data-nosnippet>731</a></span><span class="kw">impl </span>From&lt;UdpSocket&gt; <span class="kw">for </span>OwnedSocket {
<a href=#732 id=732 data-nosnippet>732</a> <span class="kw">fn </span>from(udp_socket: UdpSocket) -&gt; <span class="self">Self </span>{
<a href=#733 id=733 data-nosnippet>733</a> udp_socket.inner.into_inner().into()
<a href=#734 id=734 data-nosnippet>734</a> }
<a href=#735 id=735 data-nosnippet>735</a>}
<a href=#736 id=736 data-nosnippet>736</a>
<a href=#737 id=737 data-nosnippet>737</a><span class="attr">#[cfg(windows)]
<a href=#738 id=738 data-nosnippet>738</a></span><span class="kw">impl </span>AsSocket <span class="kw">for </span>UdpSocket {
<a href=#739 id=739 data-nosnippet>739</a> <span class="kw">fn </span>as_socket(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedSocket&lt;<span class="lifetime">'_</span>&gt; {
<a href=#740 id=740 data-nosnippet>740</a> <span class="self">self</span>.inner.as_socket()
<a href=#741 id=741 data-nosnippet>741</a> }
<a href=#742 id=742 data-nosnippet>742</a>}
<a href=#743 id=743 data-nosnippet>743</a>
<a href=#744 id=744 data-nosnippet>744</a><span class="attr">#[cfg(windows)]
<a href=#745 id=745 data-nosnippet>745</a></span><span class="kw">impl </span>From&lt;OwnedSocket&gt; <span class="kw">for </span>UdpSocket {
<a href=#746 id=746 data-nosnippet>746</a> <span class="doccomment">/// Converts a `RawSocket` to a `UdpSocket`.
<a href=#747 id=747 data-nosnippet>747</a> ///
<a href=#748 id=748 data-nosnippet>748</a> /// # Notes
<a href=#749 id=749 data-nosnippet>749</a> ///
<a href=#750 id=750 data-nosnippet>750</a> /// The caller is responsible for ensuring that the socket is in
<a href=#751 id=751 data-nosnippet>751</a> /// non-blocking mode.
<a href=#752 id=752 data-nosnippet>752</a> </span><span class="kw">fn </span>from(socket: OwnedSocket) -&gt; <span class="self">Self </span>{
<a href=#753 id=753 data-nosnippet>753</a> UdpSocket::from_std(From::from(socket))
<a href=#754 id=754 data-nosnippet>754</a> }
<a href=#755 id=755 data-nosnippet>755</a>}
<a href=#756 id=756 data-nosnippet>756</a>
<a href=#757 id=757 data-nosnippet>757</a><span class="kw">impl </span>From&lt;UdpSocket&gt; <span class="kw">for </span>net::UdpSocket {
<a href=#758 id=758 data-nosnippet>758</a> <span class="kw">fn </span>from(socket: UdpSocket) -&gt; <span class="self">Self </span>{
<a href=#759 id=759 data-nosnippet>759</a> <span class="comment">// Safety: This is safe since we are extracting the raw fd from a well-constructed
<a href=#760 id=760 data-nosnippet>760</a> // mio::net::UdpSocket which ensures that we actually pass in a valid file
<a href=#761 id=761 data-nosnippet>761</a> // descriptor/socket
<a href=#762 id=762 data-nosnippet>762</a> </span><span class="kw">unsafe </span>{
<a href=#763 id=763 data-nosnippet>763</a> <span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>, target_os = <span class="string">"wasi"</span>))]
<a href=#764 id=764 data-nosnippet>764</a> </span>{
<a href=#765 id=765 data-nosnippet>765</a> net::UdpSocket::from_raw_fd(socket.into_raw_fd())
<a href=#766 id=766 data-nosnippet>766</a> }
<a href=#767 id=767 data-nosnippet>767</a> <span class="attr">#[cfg(windows)]
<a href=#768 id=768 data-nosnippet>768</a> </span>{
<a href=#769 id=769 data-nosnippet>769</a> net::UdpSocket::from_raw_socket(socket.into_raw_socket())
<a href=#770 id=770 data-nosnippet>770</a> }
<a href=#771 id=771 data-nosnippet>771</a> }
<a href=#772 id=772 data-nosnippet>772</a> }
<a href=#773 id=773 data-nosnippet>773</a>}
</code></pre></div></section></main></body></html>
+269
View File
@@ -0,0 +1,269 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/uds/datagram.rs`."><title>datagram.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/uds/</div>datagram.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::net::Shutdown;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::os::unix::net::{<span class="self">self</span>, SocketAddr};
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::path::Path;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::{fmt, io};
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use crate</span>::{event, sys, Interest, Registry, Token};
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="doccomment">/// A Unix datagram socket.
<a href=#11 id=11 data-nosnippet>11</a></span><span class="kw">pub struct </span>UnixDatagram {
<a href=#12 id=12 data-nosnippet>12</a> inner: IoSource&lt;net::UnixDatagram&gt;,
<a href=#13 id=13 data-nosnippet>13</a>}
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">impl </span>UnixDatagram {
<a href=#16 id=16 data-nosnippet>16</a> <span class="doccomment">/// Creates a Unix datagram socket bound to the given path.
<a href=#17 id=17 data-nosnippet>17</a> </span><span class="kw">pub fn </span>bind&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;UnixDatagram&gt; {
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">let </span>addr = SocketAddr::from_pathname(path)<span class="question-mark">?</span>;
<a href=#19 id=19 data-nosnippet>19</a> UnixDatagram::bind_addr(<span class="kw-2">&amp;</span>addr)
<a href=#20 id=20 data-nosnippet>20</a> }
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a> <span class="doccomment">/// Creates a new `UnixDatagram` bound to the specified socket `address`.
<a href=#23 id=23 data-nosnippet>23</a> </span><span class="kw">pub fn </span>bind_addr(address: <span class="kw-2">&amp;</span>SocketAddr) -&gt; io::Result&lt;UnixDatagram&gt; {
<a href=#24 id=24 data-nosnippet>24</a> sys::uds::datagram::bind_addr(address).map(UnixDatagram::from_std)
<a href=#25 id=25 data-nosnippet>25</a> }
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a> <span class="doccomment">/// Creates a new `UnixDatagram` from a standard `net::UnixDatagram`.
<a href=#28 id=28 data-nosnippet>28</a> ///
<a href=#29 id=29 data-nosnippet>29</a> /// This function is intended to be used to wrap a Unix datagram from the
<a href=#30 id=30 data-nosnippet>30</a> /// standard library in the Mio equivalent. The conversion assumes nothing
<a href=#31 id=31 data-nosnippet>31</a> /// about the underlying datagram; it is left up to the user to set it in
<a href=#32 id=32 data-nosnippet>32</a> /// non-blocking mode.
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="kw">pub fn </span>from_std(socket: net::UnixDatagram) -&gt; UnixDatagram {
<a href=#34 id=34 data-nosnippet>34</a> UnixDatagram {
<a href=#35 id=35 data-nosnippet>35</a> inner: IoSource::new(socket),
<a href=#36 id=36 data-nosnippet>36</a> }
<a href=#37 id=37 data-nosnippet>37</a> }
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> <span class="doccomment">/// Connects the socket to the specified address.
<a href=#40 id=40 data-nosnippet>40</a> ///
<a href=#41 id=41 data-nosnippet>41</a> /// This may return a `WouldBlock` in which case the socket connection
<a href=#42 id=42 data-nosnippet>42</a> /// cannot be completed immediately.
<a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">pub fn </span>connect&lt;P: AsRef&lt;Path&gt;&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, path: P) -&gt; io::Result&lt;()&gt; {
<a href=#44 id=44 data-nosnippet>44</a> <span class="self">self</span>.inner.connect(path)
<a href=#45 id=45 data-nosnippet>45</a> }
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a> <span class="doccomment">/// Creates a Unix Datagram socket which is not bound to any address.
<a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">pub fn </span>unbound() -&gt; io::Result&lt;UnixDatagram&gt; {
<a href=#49 id=49 data-nosnippet>49</a> sys::uds::datagram::unbound().map(UnixDatagram::from_std)
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// Create an unnamed pair of connected sockets.
<a href=#53 id=53 data-nosnippet>53</a> </span><span class="kw">pub fn </span>pair() -&gt; io::Result&lt;(UnixDatagram, UnixDatagram)&gt; {
<a href=#54 id=54 data-nosnippet>54</a> sys::uds::datagram::pair().map(|(socket1, socket2)| {
<a href=#55 id=55 data-nosnippet>55</a> (
<a href=#56 id=56 data-nosnippet>56</a> UnixDatagram::from_std(socket1),
<a href=#57 id=57 data-nosnippet>57</a> UnixDatagram::from_std(socket2),
<a href=#58 id=58 data-nosnippet>58</a> )
<a href=#59 id=59 data-nosnippet>59</a> })
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a> <span class="doccomment">/// Returns the address of this socket.
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#64 id=64 data-nosnippet>64</a> <span class="self">self</span>.inner.local_addr()
<a href=#65 id=65 data-nosnippet>65</a> }
<a href=#66 id=66 data-nosnippet>66</a>
<a href=#67 id=67 data-nosnippet>67</a> <span class="doccomment">/// Returns the address of this socket's peer.
<a href=#68 id=68 data-nosnippet>68</a> ///
<a href=#69 id=69 data-nosnippet>69</a> /// The `connect` method will connect the socket to a peer.
<a href=#70 id=70 data-nosnippet>70</a> </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#71 id=71 data-nosnippet>71</a> <span class="self">self</span>.inner.peer_addr()
<a href=#72 id=72 data-nosnippet>72</a> }
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a> <span class="doccomment">/// Receives data from the socket.
<a href=#75 id=75 data-nosnippet>75</a> ///
<a href=#76 id=76 data-nosnippet>76</a> /// On success, returns the number of bytes read and the address from
<a href=#77 id=77 data-nosnippet>77</a> /// whence the data came.
<a href=#78 id=78 data-nosnippet>78</a> </span><span class="kw">pub fn </span>recv_from(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;(usize, SocketAddr)&gt; {
<a href=#79 id=79 data-nosnippet>79</a> <span class="self">self</span>.inner.do_io(|inner| inner.recv_from(buf))
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a> <span class="doccomment">/// Receives data from the socket.
<a href=#83 id=83 data-nosnippet>83</a> ///
<a href=#84 id=84 data-nosnippet>84</a> /// On success, returns the number of bytes read.
<a href=#85 id=85 data-nosnippet>85</a> </span><span class="kw">pub fn </span>recv(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#86 id=86 data-nosnippet>86</a> <span class="self">self</span>.inner.do_io(|inner| inner.recv(buf))
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a>
<a href=#89 id=89 data-nosnippet>89</a> <span class="doccomment">/// Sends data on the socket to the specified address.
<a href=#90 id=90 data-nosnippet>90</a> ///
<a href=#91 id=91 data-nosnippet>91</a> /// On success, returns the number of bytes written.
<a href=#92 id=92 data-nosnippet>92</a> </span><span class="kw">pub fn </span>send_to&lt;P: AsRef&lt;Path&gt;&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8], path: P) -&gt; io::Result&lt;usize&gt; {
<a href=#93 id=93 data-nosnippet>93</a> <span class="self">self</span>.inner.do_io(|inner| inner.send_to(buf, path))
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a>
<a href=#96 id=96 data-nosnippet>96</a> <span class="doccomment">/// Sends data on the socket to the socket's peer.
<a href=#97 id=97 data-nosnippet>97</a> ///
<a href=#98 id=98 data-nosnippet>98</a> /// The peer address may be set by the `connect` method, and this method
<a href=#99 id=99 data-nosnippet>99</a> /// will return an error if the socket has not already been connected.
<a href=#100 id=100 data-nosnippet>100</a> ///
<a href=#101 id=101 data-nosnippet>101</a> /// On success, returns the number of bytes written.
<a href=#102 id=102 data-nosnippet>102</a> </span><span class="kw">pub fn </span>send(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#103 id=103 data-nosnippet>103</a> <span class="self">self</span>.inner.do_io(|inner| inner.send(buf))
<a href=#104 id=104 data-nosnippet>104</a> }
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="doccomment">/// Returns the value of the `SO_ERROR` option.
<a href=#107 id=107 data-nosnippet>107</a> </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;io::Error&gt;&gt; {
<a href=#108 id=108 data-nosnippet>108</a> <span class="self">self</span>.inner.take_error()
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a>
<a href=#111 id=111 data-nosnippet>111</a> <span class="doccomment">/// Shut down the read, write, or both halves of this connection.
<a href=#112 id=112 data-nosnippet>112</a> ///
<a href=#113 id=113 data-nosnippet>113</a> /// This function will cause all pending and future I/O calls on the
<a href=#114 id=114 data-nosnippet>114</a> /// specified portions to immediately return with an appropriate value
<a href=#115 id=115 data-nosnippet>115</a> /// (see the documentation of `Shutdown`).
<a href=#116 id=116 data-nosnippet>116</a> </span><span class="kw">pub fn </span>shutdown(<span class="kw-2">&amp;</span><span class="self">self</span>, how: Shutdown) -&gt; io::Result&lt;()&gt; {
<a href=#117 id=117 data-nosnippet>117</a> <span class="self">self</span>.inner.shutdown(how)
<a href=#118 id=118 data-nosnippet>118</a> }
<a href=#119 id=119 data-nosnippet>119</a>
<a href=#120 id=120 data-nosnippet>120</a> <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events
<a href=#121 id=121 data-nosnippet>121</a> /// if it hits a [`WouldBlock`] error.
<a href=#122 id=122 data-nosnippet>122</a> ///
<a href=#123 id=123 data-nosnippet>123</a> /// # Notes
<a href=#124 id=124 data-nosnippet>124</a> ///
<a href=#125 id=125 data-nosnippet>125</a> /// This method is required to be called for **all** I/O operations to
<a href=#126 id=126 data-nosnippet>126</a> /// ensure the user will receive events once the socket is ready again after
<a href=#127 id=127 data-nosnippet>127</a> /// returning a [`WouldBlock`] error.
<a href=#128 id=128 data-nosnippet>128</a> ///
<a href=#129 id=129 data-nosnippet>129</a> /// [`WouldBlock`]: io::ErrorKind::WouldBlock
<a href=#130 id=130 data-nosnippet>130</a> ///
<a href=#131 id=131 data-nosnippet>131</a> /// # Examples
<a href=#132 id=132 data-nosnippet>132</a> ///
<a href=#133 id=133 data-nosnippet>133</a> /// ```
<a href=#134 id=134 data-nosnippet>134</a> /// # use std::error::Error;
<a href=#135 id=135 data-nosnippet>135</a> /// #
<a href=#136 id=136 data-nosnippet>136</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#137 id=137 data-nosnippet>137</a> /// use std::io;
<a href=#138 id=138 data-nosnippet>138</a> /// use std::os::fd::AsRawFd;
<a href=#139 id=139 data-nosnippet>139</a> /// use mio::net::UnixDatagram;
<a href=#140 id=140 data-nosnippet>140</a> ///
<a href=#141 id=141 data-nosnippet>141</a> /// let (dgram1, dgram2) = UnixDatagram::pair()?;
<a href=#142 id=142 data-nosnippet>142</a> ///
<a href=#143 id=143 data-nosnippet>143</a> /// // Wait until the dgram is writable...
<a href=#144 id=144 data-nosnippet>144</a> ///
<a href=#145 id=145 data-nosnippet>145</a> /// // Write to the dgram using a direct libc call, of course the
<a href=#146 id=146 data-nosnippet>146</a> /// // `io::Write` implementation would be easier to use.
<a href=#147 id=147 data-nosnippet>147</a> /// let buf = b"hello";
<a href=#148 id=148 data-nosnippet>148</a> /// let n = dgram1.try_io(|| {
<a href=#149 id=149 data-nosnippet>149</a> /// let buf_ptr = &amp;buf as *const _ as *const _;
<a href=#150 id=150 data-nosnippet>150</a> /// let res = unsafe { libc::send(dgram1.as_raw_fd(), buf_ptr, buf.len(), 0) };
<a href=#151 id=151 data-nosnippet>151</a> /// if res != -1 {
<a href=#152 id=152 data-nosnippet>152</a> /// Ok(res as usize)
<a href=#153 id=153 data-nosnippet>153</a> /// } else {
<a href=#154 id=154 data-nosnippet>154</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::send, the closure
<a href=#155 id=155 data-nosnippet>155</a> /// // should return `WouldBlock` error.
<a href=#156 id=156 data-nosnippet>156</a> /// Err(io::Error::last_os_error())
<a href=#157 id=157 data-nosnippet>157</a> /// }
<a href=#158 id=158 data-nosnippet>158</a> /// })?;
<a href=#159 id=159 data-nosnippet>159</a> /// eprintln!("write {} bytes", n);
<a href=#160 id=160 data-nosnippet>160</a> ///
<a href=#161 id=161 data-nosnippet>161</a> /// // Wait until the dgram is readable...
<a href=#162 id=162 data-nosnippet>162</a> ///
<a href=#163 id=163 data-nosnippet>163</a> /// // Read from the dgram using a direct libc call, of course the
<a href=#164 id=164 data-nosnippet>164</a> /// // `io::Read` implementation would be easier to use.
<a href=#165 id=165 data-nosnippet>165</a> /// let mut buf = [0; 512];
<a href=#166 id=166 data-nosnippet>166</a> /// let n = dgram2.try_io(|| {
<a href=#167 id=167 data-nosnippet>167</a> /// let buf_ptr = &amp;mut buf as *mut _ as *mut _;
<a href=#168 id=168 data-nosnippet>168</a> /// let res = unsafe { libc::recv(dgram2.as_raw_fd(), buf_ptr, buf.len(), 0) };
<a href=#169 id=169 data-nosnippet>169</a> /// if res != -1 {
<a href=#170 id=170 data-nosnippet>170</a> /// Ok(res as usize)
<a href=#171 id=171 data-nosnippet>171</a> /// } else {
<a href=#172 id=172 data-nosnippet>172</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure
<a href=#173 id=173 data-nosnippet>173</a> /// // should return `WouldBlock` error.
<a href=#174 id=174 data-nosnippet>174</a> /// Err(io::Error::last_os_error())
<a href=#175 id=175 data-nosnippet>175</a> /// }
<a href=#176 id=176 data-nosnippet>176</a> /// })?;
<a href=#177 id=177 data-nosnippet>177</a> /// eprintln!("read {} bytes", n);
<a href=#178 id=178 data-nosnippet>178</a> /// # Ok(())
<a href=#179 id=179 data-nosnippet>179</a> /// # }
<a href=#180 id=180 data-nosnippet>180</a> /// ```
<a href=#181 id=181 data-nosnippet>181</a> </span><span class="kw">pub fn </span>try_io&lt;F, T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; io::Result&lt;T&gt;
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw">where
<a href=#183 id=183 data-nosnippet>183</a> </span>F: FnOnce() -&gt; io::Result&lt;T&gt;,
<a href=#184 id=184 data-nosnippet>184</a> {
<a href=#185 id=185 data-nosnippet>185</a> <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f())
<a href=#186 id=186 data-nosnippet>186</a> }
<a href=#187 id=187 data-nosnippet>187</a>}
<a href=#188 id=188 data-nosnippet>188</a>
<a href=#189 id=189 data-nosnippet>189</a><span class="kw">impl </span>event::Source <span class="kw">for </span>UnixDatagram {
<a href=#190 id=190 data-nosnippet>190</a> <span class="kw">fn </span>register(
<a href=#191 id=191 data-nosnippet>191</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#192 id=192 data-nosnippet>192</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#193 id=193 data-nosnippet>193</a> token: Token,
<a href=#194 id=194 data-nosnippet>194</a> interests: Interest,
<a href=#195 id=195 data-nosnippet>195</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#196 id=196 data-nosnippet>196</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#197 id=197 data-nosnippet>197</a> }
<a href=#198 id=198 data-nosnippet>198</a>
<a href=#199 id=199 data-nosnippet>199</a> <span class="kw">fn </span>reregister(
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#201 id=201 data-nosnippet>201</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#202 id=202 data-nosnippet>202</a> token: Token,
<a href=#203 id=203 data-nosnippet>203</a> interests: Interest,
<a href=#204 id=204 data-nosnippet>204</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#205 id=205 data-nosnippet>205</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#206 id=206 data-nosnippet>206</a> }
<a href=#207 id=207 data-nosnippet>207</a>
<a href=#208 id=208 data-nosnippet>208</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#209 id=209 data-nosnippet>209</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#210 id=210 data-nosnippet>210</a> }
<a href=#211 id=211 data-nosnippet>211</a>}
<a href=#212 id=212 data-nosnippet>212</a>
<a href=#213 id=213 data-nosnippet>213</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UnixDatagram {
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#215 id=215 data-nosnippet>215</a> <span class="self">self</span>.inner.fmt(f)
<a href=#216 id=216 data-nosnippet>216</a> }
<a href=#217 id=217 data-nosnippet>217</a>}
<a href=#218 id=218 data-nosnippet>218</a>
<a href=#219 id=219 data-nosnippet>219</a><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>UnixDatagram {
<a href=#220 id=220 data-nosnippet>220</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#221 id=221 data-nosnippet>221</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#222 id=222 data-nosnippet>222</a> }
<a href=#223 id=223 data-nosnippet>223</a>}
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a><span class="kw">impl </span>AsRawFd <span class="kw">for </span>UnixDatagram {
<a href=#226 id=226 data-nosnippet>226</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#227 id=227 data-nosnippet>227</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#228 id=228 data-nosnippet>228</a> }
<a href=#229 id=229 data-nosnippet>229</a>}
<a href=#230 id=230 data-nosnippet>230</a>
<a href=#231 id=231 data-nosnippet>231</a><span class="kw">impl </span>FromRawFd <span class="kw">for </span>UnixDatagram {
<a href=#232 id=232 data-nosnippet>232</a> <span class="doccomment">/// Converts a `RawFd` to a `UnixDatagram`.
<a href=#233 id=233 data-nosnippet>233</a> ///
<a href=#234 id=234 data-nosnippet>234</a> /// # Notes
<a href=#235 id=235 data-nosnippet>235</a> ///
<a href=#236 id=236 data-nosnippet>236</a> /// The caller is responsible for ensuring that the socket is in
<a href=#237 id=237 data-nosnippet>237</a> /// non-blocking mode.
<a href=#238 id=238 data-nosnippet>238</a> </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; UnixDatagram {
<a href=#239 id=239 data-nosnippet>239</a> UnixDatagram::from_std(FromRawFd::from_raw_fd(fd))
<a href=#240 id=240 data-nosnippet>240</a> }
<a href=#241 id=241 data-nosnippet>241</a>}
<a href=#242 id=242 data-nosnippet>242</a>
<a href=#243 id=243 data-nosnippet>243</a><span class="kw">impl </span>From&lt;UnixDatagram&gt; <span class="kw">for </span>net::UnixDatagram {
<a href=#244 id=244 data-nosnippet>244</a> <span class="kw">fn </span>from(datagram: UnixDatagram) -&gt; <span class="self">Self </span>{
<a href=#245 id=245 data-nosnippet>245</a> <span class="comment">// Safety: This is safe since we are extracting the raw fd from a well-constructed
<a href=#246 id=246 data-nosnippet>246</a> // mio::net::uds::UnixListener which ensures that we actually pass in a valid file
<a href=#247 id=247 data-nosnippet>247</a> // descriptor/socket
<a href=#248 id=248 data-nosnippet>248</a> </span><span class="kw">unsafe </span>{ net::UnixDatagram::from_raw_fd(datagram.into_raw_fd()) }
<a href=#249 id=249 data-nosnippet>249</a> }
<a href=#250 id=250 data-nosnippet>250</a>}
<a href=#251 id=251 data-nosnippet>251</a>
<a href=#252 id=252 data-nosnippet>252</a><span class="kw">impl </span>From&lt;UnixDatagram&gt; <span class="kw">for </span>OwnedFd {
<a href=#253 id=253 data-nosnippet>253</a> <span class="kw">fn </span>from(unix_datagram: UnixDatagram) -&gt; <span class="self">Self </span>{
<a href=#254 id=254 data-nosnippet>254</a> unix_datagram.inner.into_inner().into()
<a href=#255 id=255 data-nosnippet>255</a> }
<a href=#256 id=256 data-nosnippet>256</a>}
<a href=#257 id=257 data-nosnippet>257</a>
<a href=#258 id=258 data-nosnippet>258</a><span class="kw">impl </span>AsFd <span class="kw">for </span>UnixDatagram {
<a href=#259 id=259 data-nosnippet>259</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#260 id=260 data-nosnippet>260</a> <span class="self">self</span>.inner.as_fd()
<a href=#261 id=261 data-nosnippet>261</a> }
<a href=#262 id=262 data-nosnippet>262</a>}
<a href=#263 id=263 data-nosnippet>263</a>
<a href=#264 id=264 data-nosnippet>264</a><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>UnixDatagram {
<a href=#265 id=265 data-nosnippet>265</a> <span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#266 id=266 data-nosnippet>266</a> UnixDatagram::from_std(From::from(fd))
<a href=#267 id=267 data-nosnippet>267</a> }
<a href=#268 id=268 data-nosnippet>268</a>}
</code></pre></div></section></main></body></html>
+138
View File
@@ -0,0 +1,138 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/uds/listener.rs`."><title>listener.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/uds/</div>listener.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::os::unix::net::{<span class="self">self</span>, SocketAddr};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::path::Path;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::{fmt, io};
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span><span class="kw">crate</span>::net::UnixStream;
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use crate</span>::{event, sys, Interest, Registry, Token};
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="doccomment">/// A non-blocking Unix domain socket server.
<a href=#11 id=11 data-nosnippet>11</a></span><span class="kw">pub struct </span>UnixListener {
<a href=#12 id=12 data-nosnippet>12</a> inner: IoSource&lt;net::UnixListener&gt;,
<a href=#13 id=13 data-nosnippet>13</a>}
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">impl </span>UnixListener {
<a href=#16 id=16 data-nosnippet>16</a> <span class="doccomment">/// Creates a new `UnixListener` bound to the specified socket `path`.
<a href=#17 id=17 data-nosnippet>17</a> </span><span class="kw">pub fn </span>bind&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;UnixListener&gt; {
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">let </span>addr = SocketAddr::from_pathname(path)<span class="question-mark">?</span>;
<a href=#19 id=19 data-nosnippet>19</a> UnixListener::bind_addr(<span class="kw-2">&amp;</span>addr)
<a href=#20 id=20 data-nosnippet>20</a> }
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a> <span class="doccomment">/// Creates a new `UnixListener` bound to the specified socket `address`.
<a href=#23 id=23 data-nosnippet>23</a> </span><span class="kw">pub fn </span>bind_addr(address: <span class="kw-2">&amp;</span>SocketAddr) -&gt; io::Result&lt;UnixListener&gt; {
<a href=#24 id=24 data-nosnippet>24</a> sys::uds::listener::bind_addr(address).map(UnixListener::from_std)
<a href=#25 id=25 data-nosnippet>25</a> }
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a> <span class="doccomment">/// Creates a new `UnixListener` from a standard `net::UnixListener`.
<a href=#28 id=28 data-nosnippet>28</a> ///
<a href=#29 id=29 data-nosnippet>29</a> /// This function is intended to be used to wrap a Unix listener from the
<a href=#30 id=30 data-nosnippet>30</a> /// standard library in the Mio equivalent. The conversion assumes nothing
<a href=#31 id=31 data-nosnippet>31</a> /// about the underlying listener; it is left up to the user to set it in
<a href=#32 id=32 data-nosnippet>32</a> /// non-blocking mode.
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="kw">pub fn </span>from_std(listener: net::UnixListener) -&gt; UnixListener {
<a href=#34 id=34 data-nosnippet>34</a> UnixListener {
<a href=#35 id=35 data-nosnippet>35</a> inner: IoSource::new(listener),
<a href=#36 id=36 data-nosnippet>36</a> }
<a href=#37 id=37 data-nosnippet>37</a> }
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> <span class="doccomment">/// Accepts a new incoming connection to this listener.
<a href=#40 id=40 data-nosnippet>40</a> ///
<a href=#41 id=41 data-nosnippet>41</a> /// The call is responsible for ensuring that the listening socket is in
<a href=#42 id=42 data-nosnippet>42</a> /// non-blocking mode.
<a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">pub fn </span>accept(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;(UnixStream, SocketAddr)&gt; {
<a href=#44 id=44 data-nosnippet>44</a> sys::uds::listener::accept(<span class="kw-2">&amp;</span><span class="self">self</span>.inner)
<a href=#45 id=45 data-nosnippet>45</a> }
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a> <span class="doccomment">/// Returns the local socket address of this listener.
<a href=#48 id=48 data-nosnippet>48</a> </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#49 id=49 data-nosnippet>49</a> <span class="self">self</span>.inner.local_addr()
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// Returns the value of the `SO_ERROR` option.
<a href=#53 id=53 data-nosnippet>53</a> </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;io::Error&gt;&gt; {
<a href=#54 id=54 data-nosnippet>54</a> <span class="self">self</span>.inner.take_error()
<a href=#55 id=55 data-nosnippet>55</a> }
<a href=#56 id=56 data-nosnippet>56</a>}
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a><span class="kw">impl </span>event::Source <span class="kw">for </span>UnixListener {
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">fn </span>register(
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#61 id=61 data-nosnippet>61</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#62 id=62 data-nosnippet>62</a> token: Token,
<a href=#63 id=63 data-nosnippet>63</a> interests: Interest,
<a href=#64 id=64 data-nosnippet>64</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#65 id=65 data-nosnippet>65</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#66 id=66 data-nosnippet>66</a> }
<a href=#67 id=67 data-nosnippet>67</a>
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">fn </span>reregister(
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#70 id=70 data-nosnippet>70</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#71 id=71 data-nosnippet>71</a> token: Token,
<a href=#72 id=72 data-nosnippet>72</a> interests: Interest,
<a href=#73 id=73 data-nosnippet>73</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#74 id=74 data-nosnippet>74</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#75 id=75 data-nosnippet>75</a> }
<a href=#76 id=76 data-nosnippet>76</a>
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#78 id=78 data-nosnippet>78</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#79 id=79 data-nosnippet>79</a> }
<a href=#80 id=80 data-nosnippet>80</a>}
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UnixListener {
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#84 id=84 data-nosnippet>84</a> <span class="self">self</span>.inner.fmt(f)
<a href=#85 id=85 data-nosnippet>85</a> }
<a href=#86 id=86 data-nosnippet>86</a>}
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>UnixListener {
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#90 id=90 data-nosnippet>90</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#91 id=91 data-nosnippet>91</a> }
<a href=#92 id=92 data-nosnippet>92</a>}
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a><span class="kw">impl </span>AsRawFd <span class="kw">for </span>UnixListener {
<a href=#95 id=95 data-nosnippet>95</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#96 id=96 data-nosnippet>96</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#97 id=97 data-nosnippet>97</a> }
<a href=#98 id=98 data-nosnippet>98</a>}
<a href=#99 id=99 data-nosnippet>99</a>
<a href=#100 id=100 data-nosnippet>100</a><span class="kw">impl </span>FromRawFd <span class="kw">for </span>UnixListener {
<a href=#101 id=101 data-nosnippet>101</a> <span class="doccomment">/// Converts a `RawFd` to a `UnixListener`.
<a href=#102 id=102 data-nosnippet>102</a> ///
<a href=#103 id=103 data-nosnippet>103</a> /// # Notes
<a href=#104 id=104 data-nosnippet>104</a> ///
<a href=#105 id=105 data-nosnippet>105</a> /// The caller is responsible for ensuring that the socket is in
<a href=#106 id=106 data-nosnippet>106</a> /// non-blocking mode.
<a href=#107 id=107 data-nosnippet>107</a> </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; UnixListener {
<a href=#108 id=108 data-nosnippet>108</a> UnixListener::from_std(FromRawFd::from_raw_fd(fd))
<a href=#109 id=109 data-nosnippet>109</a> }
<a href=#110 id=110 data-nosnippet>110</a>}
<a href=#111 id=111 data-nosnippet>111</a>
<a href=#112 id=112 data-nosnippet>112</a><span class="kw">impl </span>From&lt;UnixListener&gt; <span class="kw">for </span>net::UnixListener {
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">fn </span>from(listener: UnixListener) -&gt; <span class="self">Self </span>{
<a href=#114 id=114 data-nosnippet>114</a> <span class="comment">// Safety: This is safe since we are extracting the raw fd from a well-constructed
<a href=#115 id=115 data-nosnippet>115</a> // mio::net::uds::UnixListener which ensures that we actually pass in a valid file
<a href=#116 id=116 data-nosnippet>116</a> // descriptor/socket
<a href=#117 id=117 data-nosnippet>117</a> </span><span class="kw">unsafe </span>{ net::UnixListener::from_raw_fd(listener.into_raw_fd()) }
<a href=#118 id=118 data-nosnippet>118</a> }
<a href=#119 id=119 data-nosnippet>119</a>}
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a><span class="kw">impl </span>From&lt;UnixListener&gt; <span class="kw">for </span>OwnedFd {
<a href=#122 id=122 data-nosnippet>122</a> <span class="kw">fn </span>from(unix_listener: UnixListener) -&gt; <span class="self">Self </span>{
<a href=#123 id=123 data-nosnippet>123</a> unix_listener.inner.into_inner().into()
<a href=#124 id=124 data-nosnippet>124</a> }
<a href=#125 id=125 data-nosnippet>125</a>}
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a><span class="kw">impl </span>AsFd <span class="kw">for </span>UnixListener {
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#129 id=129 data-nosnippet>129</a> <span class="self">self</span>.inner.as_fd()
<a href=#130 id=130 data-nosnippet>130</a> }
<a href=#131 id=131 data-nosnippet>131</a>}
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>UnixListener {
<a href=#134 id=134 data-nosnippet>134</a> <span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#135 id=135 data-nosnippet>135</a> UnixListener::from_std(From::from(fd))
<a href=#136 id=136 data-nosnippet>136</a> }
<a href=#137 id=137 data-nosnippet>137</a>}
</code></pre></div></section></main></body></html>
+9
View File
@@ -0,0 +1,9 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/uds/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/uds/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-1"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">mod </span>datagram;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">pub use </span><span class="self">self</span>::datagram::UnixDatagram;
<a href=#3 id=3 data-nosnippet>3</a>
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">mod </span>listener;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub use </span><span class="self">self</span>::listener::UnixListener;
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">mod </span>stream;
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub use </span><span class="self">self</span>::stream::UnixStream;
</code></pre></div></section></main></body></html>
+282
View File
@@ -0,0 +1,282 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/net/uds/stream.rs`."><title>stream.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/net/uds/</div>stream.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::fmt;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::io::{<span class="self">self</span>, IoSlice, IoSliceMut, Read, Write};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::net::Shutdown;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::os::unix::net::{<span class="self">self</span>, SocketAddr};
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>std::path::Path;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">use crate</span>::{event, sys, Interest, Registry, Token};
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="doccomment">/// A non-blocking Unix stream socket.
<a href=#12 id=12 data-nosnippet>12</a></span><span class="kw">pub struct </span>UnixStream {
<a href=#13 id=13 data-nosnippet>13</a> inner: IoSource&lt;net::UnixStream&gt;,
<a href=#14 id=14 data-nosnippet>14</a>}
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">impl </span>UnixStream {
<a href=#17 id=17 data-nosnippet>17</a> <span class="doccomment">/// Connects to the socket named by `path`.
<a href=#18 id=18 data-nosnippet>18</a> ///
<a href=#19 id=19 data-nosnippet>19</a> /// This may return a `WouldBlock` in which case the socket connection
<a href=#20 id=20 data-nosnippet>20</a> /// cannot be completed immediately. Usually it means the backlog is full.
<a href=#21 id=21 data-nosnippet>21</a> </span><span class="kw">pub fn </span>connect&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;UnixStream&gt; {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>addr = SocketAddr::from_pathname(path)<span class="question-mark">?</span>;
<a href=#23 id=23 data-nosnippet>23</a> UnixStream::connect_addr(<span class="kw-2">&amp;</span>addr)
<a href=#24 id=24 data-nosnippet>24</a> }
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a> <span class="doccomment">/// Connects to the socket named by `address`.
<a href=#27 id=27 data-nosnippet>27</a> ///
<a href=#28 id=28 data-nosnippet>28</a> /// This may return a `WouldBlock` in which case the socket connection
<a href=#29 id=29 data-nosnippet>29</a> /// cannot be completed immediately. Usually it means the backlog is full.
<a href=#30 id=30 data-nosnippet>30</a> </span><span class="kw">pub fn </span>connect_addr(address: <span class="kw-2">&amp;</span>SocketAddr) -&gt; io::Result&lt;UnixStream&gt; {
<a href=#31 id=31 data-nosnippet>31</a> sys::uds::stream::connect_addr(address).map(UnixStream::from_std)
<a href=#32 id=32 data-nosnippet>32</a> }
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a> <span class="doccomment">/// Creates a new `UnixStream` from a standard `net::UnixStream`.
<a href=#35 id=35 data-nosnippet>35</a> ///
<a href=#36 id=36 data-nosnippet>36</a> /// This function is intended to be used to wrap a Unix stream from the
<a href=#37 id=37 data-nosnippet>37</a> /// standard library in the Mio equivalent. The conversion assumes nothing
<a href=#38 id=38 data-nosnippet>38</a> /// about the underlying stream; it is left up to the user to set it in
<a href=#39 id=39 data-nosnippet>39</a> /// non-blocking mode.
<a href=#40 id=40 data-nosnippet>40</a> ///
<a href=#41 id=41 data-nosnippet>41</a> /// # Note
<a href=#42 id=42 data-nosnippet>42</a> ///
<a href=#43 id=43 data-nosnippet>43</a> /// The Unix stream here will not have `connect` called on it, so it
<a href=#44 id=44 data-nosnippet>44</a> /// should already be connected via some other means (be it manually, or
<a href=#45 id=45 data-nosnippet>45</a> /// the standard library).
<a href=#46 id=46 data-nosnippet>46</a> </span><span class="kw">pub fn </span>from_std(stream: net::UnixStream) -&gt; UnixStream {
<a href=#47 id=47 data-nosnippet>47</a> UnixStream {
<a href=#48 id=48 data-nosnippet>48</a> inner: IoSource::new(stream),
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// Creates an unnamed pair of connected sockets.
<a href=#53 id=53 data-nosnippet>53</a> ///
<a href=#54 id=54 data-nosnippet>54</a> /// Returns two `UnixStream`s which are connected to each other.
<a href=#55 id=55 data-nosnippet>55</a> </span><span class="kw">pub fn </span>pair() -&gt; io::Result&lt;(UnixStream, UnixStream)&gt; {
<a href=#56 id=56 data-nosnippet>56</a> sys::uds::stream::pair().map(|(stream1, stream2)| {
<a href=#57 id=57 data-nosnippet>57</a> (UnixStream::from_std(stream1), UnixStream::from_std(stream2))
<a href=#58 id=58 data-nosnippet>58</a> })
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="doccomment">/// Returns the socket address of the local half of this connection.
<a href=#62 id=62 data-nosnippet>62</a> </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#63 id=63 data-nosnippet>63</a> <span class="self">self</span>.inner.local_addr()
<a href=#64 id=64 data-nosnippet>64</a> }
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a> <span class="doccomment">/// Returns the socket address of the remote half of this connection.
<a href=#67 id=67 data-nosnippet>67</a> </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#68 id=68 data-nosnippet>68</a> <span class="self">self</span>.inner.peer_addr()
<a href=#69 id=69 data-nosnippet>69</a> }
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> <span class="doccomment">/// Returns the value of the `SO_ERROR` option.
<a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;<span class="prelude-ty">Option</span>&lt;io::Error&gt;&gt; {
<a href=#73 id=73 data-nosnippet>73</a> <span class="self">self</span>.inner.take_error()
<a href=#74 id=74 data-nosnippet>74</a> }
<a href=#75 id=75 data-nosnippet>75</a>
<a href=#76 id=76 data-nosnippet>76</a> <span class="doccomment">/// Shuts down the read, write, or both halves of this connection.
<a href=#77 id=77 data-nosnippet>77</a> ///
<a href=#78 id=78 data-nosnippet>78</a> /// This function will cause all pending and future I/O calls on the
<a href=#79 id=79 data-nosnippet>79</a> /// specified portions to immediately return with an appropriate value
<a href=#80 id=80 data-nosnippet>80</a> /// (see the documentation of `Shutdown`).
<a href=#81 id=81 data-nosnippet>81</a> </span><span class="kw">pub fn </span>shutdown(<span class="kw-2">&amp;</span><span class="self">self</span>, how: Shutdown) -&gt; io::Result&lt;()&gt; {
<a href=#82 id=82 data-nosnippet>82</a> <span class="self">self</span>.inner.shutdown(how)
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events
<a href=#86 id=86 data-nosnippet>86</a> /// if it hits a [`WouldBlock`] error.
<a href=#87 id=87 data-nosnippet>87</a> ///
<a href=#88 id=88 data-nosnippet>88</a> /// # Notes
<a href=#89 id=89 data-nosnippet>89</a> ///
<a href=#90 id=90 data-nosnippet>90</a> /// This method is required to be called for **all** I/O operations to
<a href=#91 id=91 data-nosnippet>91</a> /// ensure the user will receive events once the socket is ready again after
<a href=#92 id=92 data-nosnippet>92</a> /// returning a [`WouldBlock`] error.
<a href=#93 id=93 data-nosnippet>93</a> ///
<a href=#94 id=94 data-nosnippet>94</a> /// [`WouldBlock`]: io::ErrorKind::WouldBlock
<a href=#95 id=95 data-nosnippet>95</a> ///
<a href=#96 id=96 data-nosnippet>96</a> /// # Examples
<a href=#97 id=97 data-nosnippet>97</a> ///
<a href=#98 id=98 data-nosnippet>98</a> /// ```
<a href=#99 id=99 data-nosnippet>99</a> /// # use std::error::Error;
<a href=#100 id=100 data-nosnippet>100</a> /// #
<a href=#101 id=101 data-nosnippet>101</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#102 id=102 data-nosnippet>102</a> /// use std::io;
<a href=#103 id=103 data-nosnippet>103</a> /// use std::os::fd::AsRawFd;
<a href=#104 id=104 data-nosnippet>104</a> /// use mio::net::UnixStream;
<a href=#105 id=105 data-nosnippet>105</a> ///
<a href=#106 id=106 data-nosnippet>106</a> /// let (stream1, stream2) = UnixStream::pair()?;
<a href=#107 id=107 data-nosnippet>107</a> ///
<a href=#108 id=108 data-nosnippet>108</a> /// // Wait until the stream is writable...
<a href=#109 id=109 data-nosnippet>109</a> ///
<a href=#110 id=110 data-nosnippet>110</a> /// // Write to the stream using a direct libc call, of course the
<a href=#111 id=111 data-nosnippet>111</a> /// // `io::Write` implementation would be easier to use.
<a href=#112 id=112 data-nosnippet>112</a> /// let buf = b"hello";
<a href=#113 id=113 data-nosnippet>113</a> /// let n = stream1.try_io(|| {
<a href=#114 id=114 data-nosnippet>114</a> /// let buf_ptr = &amp;buf as *const _ as *const _;
<a href=#115 id=115 data-nosnippet>115</a> /// let res = unsafe { libc::send(stream1.as_raw_fd(), buf_ptr, buf.len(), 0) };
<a href=#116 id=116 data-nosnippet>116</a> /// if res != -1 {
<a href=#117 id=117 data-nosnippet>117</a> /// Ok(res as usize)
<a href=#118 id=118 data-nosnippet>118</a> /// } else {
<a href=#119 id=119 data-nosnippet>119</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::send, the closure
<a href=#120 id=120 data-nosnippet>120</a> /// // should return `WouldBlock` error.
<a href=#121 id=121 data-nosnippet>121</a> /// Err(io::Error::last_os_error())
<a href=#122 id=122 data-nosnippet>122</a> /// }
<a href=#123 id=123 data-nosnippet>123</a> /// })?;
<a href=#124 id=124 data-nosnippet>124</a> /// eprintln!("write {} bytes", n);
<a href=#125 id=125 data-nosnippet>125</a> ///
<a href=#126 id=126 data-nosnippet>126</a> /// // Wait until the stream is readable...
<a href=#127 id=127 data-nosnippet>127</a> ///
<a href=#128 id=128 data-nosnippet>128</a> /// // Read from the stream using a direct libc call, of course the
<a href=#129 id=129 data-nosnippet>129</a> /// // `io::Read` implementation would be easier to use.
<a href=#130 id=130 data-nosnippet>130</a> /// let mut buf = [0; 512];
<a href=#131 id=131 data-nosnippet>131</a> /// let n = stream2.try_io(|| {
<a href=#132 id=132 data-nosnippet>132</a> /// let buf_ptr = &amp;mut buf as *mut _ as *mut _;
<a href=#133 id=133 data-nosnippet>133</a> /// let res = unsafe { libc::recv(stream2.as_raw_fd(), buf_ptr, buf.len(), 0) };
<a href=#134 id=134 data-nosnippet>134</a> /// if res != -1 {
<a href=#135 id=135 data-nosnippet>135</a> /// Ok(res as usize)
<a href=#136 id=136 data-nosnippet>136</a> /// } else {
<a href=#137 id=137 data-nosnippet>137</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure
<a href=#138 id=138 data-nosnippet>138</a> /// // should return `WouldBlock` error.
<a href=#139 id=139 data-nosnippet>139</a> /// Err(io::Error::last_os_error())
<a href=#140 id=140 data-nosnippet>140</a> /// }
<a href=#141 id=141 data-nosnippet>141</a> /// })?;
<a href=#142 id=142 data-nosnippet>142</a> /// eprintln!("read {} bytes", n);
<a href=#143 id=143 data-nosnippet>143</a> /// # Ok(())
<a href=#144 id=144 data-nosnippet>144</a> /// # }
<a href=#145 id=145 data-nosnippet>145</a> /// ```
<a href=#146 id=146 data-nosnippet>146</a> </span><span class="kw">pub fn </span>try_io&lt;F, T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; io::Result&lt;T&gt;
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">where
<a href=#148 id=148 data-nosnippet>148</a> </span>F: FnOnce() -&gt; io::Result&lt;T&gt;,
<a href=#149 id=149 data-nosnippet>149</a> {
<a href=#150 id=150 data-nosnippet>150</a> <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f())
<a href=#151 id=151 data-nosnippet>151</a> }
<a href=#152 id=152 data-nosnippet>152</a>}
<a href=#153 id=153 data-nosnippet>153</a>
<a href=#154 id=154 data-nosnippet>154</a><span class="kw">impl </span>Read <span class="kw">for </span>UnixStream {
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#156 id=156 data-nosnippet>156</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read(buf))
<a href=#157 id=157 data-nosnippet>157</a> }
<a href=#158 id=158 data-nosnippet>158</a>
<a href=#159 id=159 data-nosnippet>159</a> <span class="kw">fn </span>read_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;mut </span>[IoSliceMut&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#160 id=160 data-nosnippet>160</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read_vectored(bufs))
<a href=#161 id=161 data-nosnippet>161</a> }
<a href=#162 id=162 data-nosnippet>162</a>}
<a href=#163 id=163 data-nosnippet>163</a>
<a href=#164 id=164 data-nosnippet>164</a><span class="kw">impl </span>Read <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">'_ </span>UnixStream {
<a href=#165 id=165 data-nosnippet>165</a> <span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#166 id=166 data-nosnippet>166</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read(buf))
<a href=#167 id=167 data-nosnippet>167</a> }
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a> <span class="kw">fn </span>read_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;mut </span>[IoSliceMut&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#170 id=170 data-nosnippet>170</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read_vectored(bufs))
<a href=#171 id=171 data-nosnippet>171</a> }
<a href=#172 id=172 data-nosnippet>172</a>}
<a href=#173 id=173 data-nosnippet>173</a>
<a href=#174 id=174 data-nosnippet>174</a><span class="kw">impl </span>Write <span class="kw">for </span>UnixStream {
<a href=#175 id=175 data-nosnippet>175</a> <span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#176 id=176 data-nosnippet>176</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write(buf))
<a href=#177 id=177 data-nosnippet>177</a> }
<a href=#178 id=178 data-nosnippet>178</a>
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">fn </span>write_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#180 id=180 data-nosnippet>180</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write_vectored(bufs))
<a href=#181 id=181 data-nosnippet>181</a> }
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#184 id=184 data-nosnippet>184</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.flush())
<a href=#185 id=185 data-nosnippet>185</a> }
<a href=#186 id=186 data-nosnippet>186</a>}
<a href=#187 id=187 data-nosnippet>187</a>
<a href=#188 id=188 data-nosnippet>188</a><span class="kw">impl </span>Write <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">'_ </span>UnixStream {
<a href=#189 id=189 data-nosnippet>189</a> <span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#190 id=190 data-nosnippet>190</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write(buf))
<a href=#191 id=191 data-nosnippet>191</a> }
<a href=#192 id=192 data-nosnippet>192</a>
<a href=#193 id=193 data-nosnippet>193</a> <span class="kw">fn </span>write_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#194 id=194 data-nosnippet>194</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write_vectored(bufs))
<a href=#195 id=195 data-nosnippet>195</a> }
<a href=#196 id=196 data-nosnippet>196</a>
<a href=#197 id=197 data-nosnippet>197</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#198 id=198 data-nosnippet>198</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.flush())
<a href=#199 id=199 data-nosnippet>199</a> }
<a href=#200 id=200 data-nosnippet>200</a>}
<a href=#201 id=201 data-nosnippet>201</a>
<a href=#202 id=202 data-nosnippet>202</a><span class="kw">impl </span>event::Source <span class="kw">for </span>UnixStream {
<a href=#203 id=203 data-nosnippet>203</a> <span class="kw">fn </span>register(
<a href=#204 id=204 data-nosnippet>204</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#205 id=205 data-nosnippet>205</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#206 id=206 data-nosnippet>206</a> token: Token,
<a href=#207 id=207 data-nosnippet>207</a> interests: Interest,
<a href=#208 id=208 data-nosnippet>208</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#209 id=209 data-nosnippet>209</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#210 id=210 data-nosnippet>210</a> }
<a href=#211 id=211 data-nosnippet>211</a>
<a href=#212 id=212 data-nosnippet>212</a> <span class="kw">fn </span>reregister(
<a href=#213 id=213 data-nosnippet>213</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#214 id=214 data-nosnippet>214</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#215 id=215 data-nosnippet>215</a> token: Token,
<a href=#216 id=216 data-nosnippet>216</a> interests: Interest,
<a href=#217 id=217 data-nosnippet>217</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#218 id=218 data-nosnippet>218</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#219 id=219 data-nosnippet>219</a> }
<a href=#220 id=220 data-nosnippet>220</a>
<a href=#221 id=221 data-nosnippet>221</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#222 id=222 data-nosnippet>222</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#223 id=223 data-nosnippet>223</a> }
<a href=#224 id=224 data-nosnippet>224</a>}
<a href=#225 id=225 data-nosnippet>225</a>
<a href=#226 id=226 data-nosnippet>226</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UnixStream {
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#228 id=228 data-nosnippet>228</a> <span class="self">self</span>.inner.fmt(f)
<a href=#229 id=229 data-nosnippet>229</a> }
<a href=#230 id=230 data-nosnippet>230</a>}
<a href=#231 id=231 data-nosnippet>231</a>
<a href=#232 id=232 data-nosnippet>232</a><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>UnixStream {
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#234 id=234 data-nosnippet>234</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#235 id=235 data-nosnippet>235</a> }
<a href=#236 id=236 data-nosnippet>236</a>}
<a href=#237 id=237 data-nosnippet>237</a>
<a href=#238 id=238 data-nosnippet>238</a><span class="kw">impl </span>AsRawFd <span class="kw">for </span>UnixStream {
<a href=#239 id=239 data-nosnippet>239</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#240 id=240 data-nosnippet>240</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#241 id=241 data-nosnippet>241</a> }
<a href=#242 id=242 data-nosnippet>242</a>}
<a href=#243 id=243 data-nosnippet>243</a>
<a href=#244 id=244 data-nosnippet>244</a><span class="kw">impl </span>FromRawFd <span class="kw">for </span>UnixStream {
<a href=#245 id=245 data-nosnippet>245</a> <span class="doccomment">/// Converts a `RawFd` to a `UnixStream`.
<a href=#246 id=246 data-nosnippet>246</a> ///
<a href=#247 id=247 data-nosnippet>247</a> /// # Notes
<a href=#248 id=248 data-nosnippet>248</a> ///
<a href=#249 id=249 data-nosnippet>249</a> /// The caller is responsible for ensuring that the socket is in
<a href=#250 id=250 data-nosnippet>250</a> /// non-blocking mode.
<a href=#251 id=251 data-nosnippet>251</a> </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; UnixStream {
<a href=#252 id=252 data-nosnippet>252</a> UnixStream::from_std(FromRawFd::from_raw_fd(fd))
<a href=#253 id=253 data-nosnippet>253</a> }
<a href=#254 id=254 data-nosnippet>254</a>}
<a href=#255 id=255 data-nosnippet>255</a>
<a href=#256 id=256 data-nosnippet>256</a><span class="kw">impl </span>From&lt;UnixStream&gt; <span class="kw">for </span>net::UnixStream {
<a href=#257 id=257 data-nosnippet>257</a> <span class="kw">fn </span>from(stream: UnixStream) -&gt; <span class="self">Self </span>{
<a href=#258 id=258 data-nosnippet>258</a> <span class="comment">// Safety: This is safe since we are extracting the raw fd from a well-constructed
<a href=#259 id=259 data-nosnippet>259</a> // mio::net::uds::UnixStream which ensures that we actually pass in a valid file
<a href=#260 id=260 data-nosnippet>260</a> // descriptor/socket
<a href=#261 id=261 data-nosnippet>261</a> </span><span class="kw">unsafe </span>{ net::UnixStream::from_raw_fd(stream.into_raw_fd()) }
<a href=#262 id=262 data-nosnippet>262</a> }
<a href=#263 id=263 data-nosnippet>263</a>}
<a href=#264 id=264 data-nosnippet>264</a>
<a href=#265 id=265 data-nosnippet>265</a><span class="kw">impl </span>From&lt;UnixStream&gt; <span class="kw">for </span>OwnedFd {
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">fn </span>from(unix_stream: UnixStream) -&gt; <span class="self">Self </span>{
<a href=#267 id=267 data-nosnippet>267</a> unix_stream.inner.into_inner().into()
<a href=#268 id=268 data-nosnippet>268</a> }
<a href=#269 id=269 data-nosnippet>269</a>}
<a href=#270 id=270 data-nosnippet>270</a>
<a href=#271 id=271 data-nosnippet>271</a><span class="kw">impl </span>AsFd <span class="kw">for </span>UnixStream {
<a href=#272 id=272 data-nosnippet>272</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#273 id=273 data-nosnippet>273</a> <span class="self">self</span>.inner.as_fd()
<a href=#274 id=274 data-nosnippet>274</a> }
<a href=#275 id=275 data-nosnippet>275</a>}
<a href=#276 id=276 data-nosnippet>276</a>
<a href=#277 id=277 data-nosnippet>277</a><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>UnixStream {
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#279 id=279 data-nosnippet>279</a> UnixStream::from_std(From::from(fd))
<a href=#280 id=280 data-nosnippet>280</a> }
<a href=#281 id=281 data-nosnippet>281</a>}
</code></pre></div></section></main></body></html>
+786
View File
@@ -0,0 +1,786 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/poll.rs`."><title>poll.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>poll.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="attr">#[cfg(all(
<a href=#2 id=2 data-nosnippet>2</a> unix,
<a href=#3 id=3 data-nosnippet>3</a> not(mio_unsupported_force_poll_poll),
<a href=#4 id=4 data-nosnippet>4</a> not(any(
<a href=#5 id=5 data-nosnippet>5</a> target_os = <span class="string">"aix"</span>,
<a href=#6 id=6 data-nosnippet>6</a> target_os = <span class="string">"espidf"</span>,
<a href=#7 id=7 data-nosnippet>7</a> target_os = <span class="string">"fuchsia"</span>,
<a href=#8 id=8 data-nosnippet>8</a> target_os = <span class="string">"haiku"</span>,
<a href=#9 id=9 data-nosnippet>9</a> target_os = <span class="string">"hermit"</span>,
<a href=#10 id=10 data-nosnippet>10</a> target_os = <span class="string">"hurd"</span>,
<a href=#11 id=11 data-nosnippet>11</a> target_os = <span class="string">"nto"</span>,
<a href=#12 id=12 data-nosnippet>12</a> target_os = <span class="string">"solaris"</span>,
<a href=#13 id=13 data-nosnippet>13</a> target_os = <span class="string">"vita"</span>,
<a href=#14 id=14 data-nosnippet>14</a> target_os = <span class="string">"cygwin"</span>,
<a href=#15 id=15 data-nosnippet>15</a> )),
<a href=#16 id=16 data-nosnippet>16</a>))]
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">use </span>std::os::fd::{AsRawFd, RawFd};
<a href=#18 id=18 data-nosnippet>18</a><span class="attr">#[cfg(all(debug_assertions, not(target_os = <span class="string">"wasi"</span>)))]
<a href=#19 id=19 data-nosnippet>19</a></span><span class="kw">use </span>std::sync::atomic::{AtomicBool, Ordering};
<a href=#20 id=20 data-nosnippet>20</a><span class="attr">#[cfg(all(debug_assertions, not(target_os = <span class="string">"wasi"</span>)))]
<a href=#21 id=21 data-nosnippet>21</a></span><span class="kw">use </span>std::sync::Arc;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>std::time::Duration;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>std::{fmt, io};
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use crate</span>::{event, sys, Events, Interest, Token};
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="doccomment">/// Polls for readiness events on all registered values.
<a href=#28 id=28 data-nosnippet>28</a>///
<a href=#29 id=29 data-nosnippet>29</a>/// `Poll` allows a program to monitor a large number of [`event::Source`]s,
<a href=#30 id=30 data-nosnippet>30</a>/// waiting until one or more become "ready" for some class of operations; e.g.
<a href=#31 id=31 data-nosnippet>31</a>/// reading and writing. An event source is considered ready if it is possible
<a href=#32 id=32 data-nosnippet>32</a>/// to immediately perform a corresponding operation; e.g. [`read`] or
<a href=#33 id=33 data-nosnippet>33</a>/// [`write`].
<a href=#34 id=34 data-nosnippet>34</a>///
<a href=#35 id=35 data-nosnippet>35</a>/// To use `Poll`, an `event::Source` must first be registered with the `Poll`
<a href=#36 id=36 data-nosnippet>36</a>/// instance using the [`register`] method on its associated `Register`,
<a href=#37 id=37 data-nosnippet>37</a>/// supplying readiness interest. The readiness interest tells `Poll` which
<a href=#38 id=38 data-nosnippet>38</a>/// specific operations on the handle to monitor for readiness. A `Token` is
<a href=#39 id=39 data-nosnippet>39</a>/// also passed to the [`register`] function. When `Poll` returns a readiness
<a href=#40 id=40 data-nosnippet>40</a>/// event, it will include this token. This associates the event with the
<a href=#41 id=41 data-nosnippet>41</a>/// event source that generated the event.
<a href=#42 id=42 data-nosnippet>42</a>///
<a href=#43 id=43 data-nosnippet>43</a>/// [`event::Source`]: ./event/trait.Source.html
<a href=#44 id=44 data-nosnippet>44</a>/// [`read`]: ./net/struct.TcpStream.html#method.read
<a href=#45 id=45 data-nosnippet>45</a>/// [`write`]: ./net/struct.TcpStream.html#method.write
<a href=#46 id=46 data-nosnippet>46</a>/// [`register`]: struct.Registry.html#method.register
<a href=#47 id=47 data-nosnippet>47</a>///
<a href=#48 id=48 data-nosnippet>48</a>/// # Examples
<a href=#49 id=49 data-nosnippet>49</a>///
<a href=#50 id=50 data-nosnippet>50</a>/// A basic example -- establishing a `TcpStream` connection.
<a href=#51 id=51 data-nosnippet>51</a>///
<a href=#52 id=52 data-nosnippet>52</a></span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#53 id=53 data-nosnippet>53</a>#[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#54 id=54 data-nosnippet>54</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#55 id=55 data-nosnippet>55</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#56 id=56 data-nosnippet>56</a>/// use mio::{Events, Poll, Interest, Token};
<a href=#57 id=57 data-nosnippet>57</a>/// use mio::net::TcpStream;
<a href=#58 id=58 data-nosnippet>58</a>///
<a href=#59 id=59 data-nosnippet>59</a>/// use std::net::{self, SocketAddr};
<a href=#60 id=60 data-nosnippet>60</a>///
<a href=#61 id=61 data-nosnippet>61</a>/// // Bind a server socket to connect to.
<a href=#62 id=62 data-nosnippet>62</a>/// let addr: SocketAddr = "127.0.0.1:0".parse()?;
<a href=#63 id=63 data-nosnippet>63</a>/// let server = net::TcpListener::bind(addr)?;
<a href=#64 id=64 data-nosnippet>64</a>///
<a href=#65 id=65 data-nosnippet>65</a>/// // Construct a new `Poll` handle as well as the `Events` we'll store into
<a href=#66 id=66 data-nosnippet>66</a>/// let mut poll = Poll::new()?;
<a href=#67 id=67 data-nosnippet>67</a>/// let mut events = Events::with_capacity(1024);
<a href=#68 id=68 data-nosnippet>68</a>///
<a href=#69 id=69 data-nosnippet>69</a>/// // Connect the stream
<a href=#70 id=70 data-nosnippet>70</a>/// let mut stream = TcpStream::connect(server.local_addr()?)?;
<a href=#71 id=71 data-nosnippet>71</a>///
<a href=#72 id=72 data-nosnippet>72</a>/// // Register the stream with `Poll`
<a href=#73 id=73 data-nosnippet>73</a>/// poll.registry().register(&amp;mut stream, Token(0), Interest::READABLE | Interest::WRITABLE)?;
<a href=#74 id=74 data-nosnippet>74</a>///
<a href=#75 id=75 data-nosnippet>75</a>/// // Wait for the socket to become ready. This has to happens in a loop to
<a href=#76 id=76 data-nosnippet>76</a>/// // handle spurious wakeups.
<a href=#77 id=77 data-nosnippet>77</a>/// loop {
<a href=#78 id=78 data-nosnippet>78</a>/// poll.poll(&amp;mut events, None)?;
<a href=#79 id=79 data-nosnippet>79</a>///
<a href=#80 id=80 data-nosnippet>80</a>/// for event in &amp;events {
<a href=#81 id=81 data-nosnippet>81</a>/// if event.token() == Token(0) &amp;&amp; event.is_writable() {
<a href=#82 id=82 data-nosnippet>82</a>/// // The socket connected (probably, it could still be a spurious
<a href=#83 id=83 data-nosnippet>83</a>/// // wakeup)
<a href=#84 id=84 data-nosnippet>84</a>/// return Ok(());
<a href=#85 id=85 data-nosnippet>85</a>/// }
<a href=#86 id=86 data-nosnippet>86</a>/// }
<a href=#87 id=87 data-nosnippet>87</a>/// }
<a href=#88 id=88 data-nosnippet>88</a>/// # }
<a href=#89 id=89 data-nosnippet>89</a>/// ```
<a href=#90 id=90 data-nosnippet>90</a>///
<a href=#91 id=91 data-nosnippet>91</a>/// # Portability
<a href=#92 id=92 data-nosnippet>92</a>///
<a href=#93 id=93 data-nosnippet>93</a>/// Using `Poll` provides a portable interface across supported platforms as
<a href=#94 id=94 data-nosnippet>94</a>/// long as the caller takes the following into consideration:
<a href=#95 id=95 data-nosnippet>95</a>///
<a href=#96 id=96 data-nosnippet>96</a>/// ### Spurious events
<a href=#97 id=97 data-nosnippet>97</a>///
<a href=#98 id=98 data-nosnippet>98</a>/// [`Poll::poll`] may return readiness events even if the associated
<a href=#99 id=99 data-nosnippet>99</a>/// event source is not actually ready. Given the same code, this may
<a href=#100 id=100 data-nosnippet>100</a>/// happen more on some platforms than others. It is important to never assume
<a href=#101 id=101 data-nosnippet>101</a>/// that, just because a readiness event was received, that the associated
<a href=#102 id=102 data-nosnippet>102</a>/// operation will succeed as well.
<a href=#103 id=103 data-nosnippet>103</a>///
<a href=#104 id=104 data-nosnippet>104</a>/// If operation fails with [`WouldBlock`], then the caller should not treat
<a href=#105 id=105 data-nosnippet>105</a>/// this as an error, but instead should wait until another readiness event is
<a href=#106 id=106 data-nosnippet>106</a>/// received.
<a href=#107 id=107 data-nosnippet>107</a>///
<a href=#108 id=108 data-nosnippet>108</a>/// ### Draining readiness
<a href=#109 id=109 data-nosnippet>109</a>///
<a href=#110 id=110 data-nosnippet>110</a>/// Once a readiness event is received, the corresponding operation must be
<a href=#111 id=111 data-nosnippet>111</a>/// performed repeatedly until it returns [`WouldBlock`]. Unless this is done,
<a href=#112 id=112 data-nosnippet>112</a>/// there is no guarantee that another readiness event will be delivered, even
<a href=#113 id=113 data-nosnippet>113</a>/// if further data is received for the event source.
<a href=#114 id=114 data-nosnippet>114</a>///
<a href=#115 id=115 data-nosnippet>115</a>/// [`WouldBlock`]: std::io::ErrorKind::WouldBlock
<a href=#116 id=116 data-nosnippet>116</a>///
<a href=#117 id=117 data-nosnippet>117</a>/// ### Readiness operations
<a href=#118 id=118 data-nosnippet>118</a>///
<a href=#119 id=119 data-nosnippet>119</a>/// The only readiness operations that are guaranteed to be present on all
<a href=#120 id=120 data-nosnippet>120</a>/// supported platforms are [`readable`] and [`writable`]. All other readiness
<a href=#121 id=121 data-nosnippet>121</a>/// operations may have false negatives and as such should be considered
<a href=#122 id=122 data-nosnippet>122</a>/// **hints**. This means that if a socket is registered with [`readable`]
<a href=#123 id=123 data-nosnippet>123</a>/// interest and either an error or close is received, a readiness event will
<a href=#124 id=124 data-nosnippet>124</a>/// be generated for the socket, but it **may** only include `readable`
<a href=#125 id=125 data-nosnippet>125</a>/// readiness. Also note that, given the potential for spurious events,
<a href=#126 id=126 data-nosnippet>126</a>/// receiving a readiness event with `read_closed`, `write_closed`, or `error`
<a href=#127 id=127 data-nosnippet>127</a>/// doesn't actually mean that a `read` on the socket will return a result
<a href=#128 id=128 data-nosnippet>128</a>/// matching the readiness event.
<a href=#129 id=129 data-nosnippet>129</a>///
<a href=#130 id=130 data-nosnippet>130</a>/// In other words, portable programs that explicitly check for [`read_closed`],
<a href=#131 id=131 data-nosnippet>131</a>/// [`write_closed`], or [`error`] readiness should be doing so as an
<a href=#132 id=132 data-nosnippet>132</a>/// **optimization** and always be able to handle an error or close situation
<a href=#133 id=133 data-nosnippet>133</a>/// when performing the actual read operation.
<a href=#134 id=134 data-nosnippet>134</a>///
<a href=#135 id=135 data-nosnippet>135</a>/// [`readable`]: ./event/struct.Event.html#method.is_readable
<a href=#136 id=136 data-nosnippet>136</a>/// [`writable`]: ./event/struct.Event.html#method.is_writable
<a href=#137 id=137 data-nosnippet>137</a>/// [`error`]: ./event/struct.Event.html#method.is_error
<a href=#138 id=138 data-nosnippet>138</a>/// [`read_closed`]: ./event/struct.Event.html#method.is_read_closed
<a href=#139 id=139 data-nosnippet>139</a>/// [`write_closed`]: ./event/struct.Event.html#method.is_write_closed
<a href=#140 id=140 data-nosnippet>140</a>///
<a href=#141 id=141 data-nosnippet>141</a>/// ### Registering handles
<a href=#142 id=142 data-nosnippet>142</a>///
<a href=#143 id=143 data-nosnippet>143</a>/// Unless otherwise noted, it should be assumed that types implementing
<a href=#144 id=144 data-nosnippet>144</a>/// [`event::Source`] will never become ready unless they are registered with
<a href=#145 id=145 data-nosnippet>145</a>/// `Poll`.
<a href=#146 id=146 data-nosnippet>146</a>///
<a href=#147 id=147 data-nosnippet>147</a>/// For example:
<a href=#148 id=148 data-nosnippet>148</a>///
<a href=#149 id=149 data-nosnippet>149</a></span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#150 id=150 data-nosnippet>150</a>#[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#151 id=151 data-nosnippet>151</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#152 id=152 data-nosnippet>152</a>/// # use std::net;
<a href=#153 id=153 data-nosnippet>153</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#154 id=154 data-nosnippet>154</a>/// use mio::{Poll, Interest, Token};
<a href=#155 id=155 data-nosnippet>155</a>/// use mio::net::TcpStream;
<a href=#156 id=156 data-nosnippet>156</a>/// use std::net::SocketAddr;
<a href=#157 id=157 data-nosnippet>157</a>/// use std::time::Duration;
<a href=#158 id=158 data-nosnippet>158</a>/// use std::thread;
<a href=#159 id=159 data-nosnippet>159</a>///
<a href=#160 id=160 data-nosnippet>160</a>/// let address: SocketAddr = "127.0.0.1:0".parse()?;
<a href=#161 id=161 data-nosnippet>161</a>/// let listener = net::TcpListener::bind(address)?;
<a href=#162 id=162 data-nosnippet>162</a>/// let mut sock = TcpStream::connect(listener.local_addr()?)?;
<a href=#163 id=163 data-nosnippet>163</a>///
<a href=#164 id=164 data-nosnippet>164</a>/// thread::sleep(Duration::from_secs(1));
<a href=#165 id=165 data-nosnippet>165</a>///
<a href=#166 id=166 data-nosnippet>166</a>/// let poll = Poll::new()?;
<a href=#167 id=167 data-nosnippet>167</a>///
<a href=#168 id=168 data-nosnippet>168</a>/// // The connect is not guaranteed to have started until it is registered at
<a href=#169 id=169 data-nosnippet>169</a>/// // this point
<a href=#170 id=170 data-nosnippet>170</a>/// poll.registry().register(&amp;mut sock, Token(0), Interest::READABLE | Interest::WRITABLE)?;
<a href=#171 id=171 data-nosnippet>171</a>/// # Ok(())
<a href=#172 id=172 data-nosnippet>172</a>/// # }
<a href=#173 id=173 data-nosnippet>173</a>/// ```
<a href=#174 id=174 data-nosnippet>174</a>///
<a href=#175 id=175 data-nosnippet>175</a>/// ### Dropping `Poll`
<a href=#176 id=176 data-nosnippet>176</a>///
<a href=#177 id=177 data-nosnippet>177</a>/// When the `Poll` instance is dropped it may cancel in-flight operations for
<a href=#178 id=178 data-nosnippet>178</a>/// the registered [event sources], meaning that no further events for them may
<a href=#179 id=179 data-nosnippet>179</a>/// be received. It also means operations on the registered event sources may no
<a href=#180 id=180 data-nosnippet>180</a>/// longer work. It is up to the user to keep the `Poll` instance alive while
<a href=#181 id=181 data-nosnippet>181</a>/// registered event sources are being used.
<a href=#182 id=182 data-nosnippet>182</a>///
<a href=#183 id=183 data-nosnippet>183</a>/// [event sources]: ./event/trait.Source.html
<a href=#184 id=184 data-nosnippet>184</a>///
<a href=#185 id=185 data-nosnippet>185</a>/// ### Accessing raw fd/socket/handle
<a href=#186 id=186 data-nosnippet>186</a>///
<a href=#187 id=187 data-nosnippet>187</a>/// Mio makes it possible for many types to be converted into a raw file
<a href=#188 id=188 data-nosnippet>188</a>/// descriptor (fd, Unix), socket (Windows) or handle (Windows). This makes it
<a href=#189 id=189 data-nosnippet>189</a>/// possible to support more operations on the type than Mio supports, for
<a href=#190 id=190 data-nosnippet>190</a>/// example it makes [mio-aio] possible. However accessing the raw fd is not
<a href=#191 id=191 data-nosnippet>191</a>/// without it's pitfalls.
<a href=#192 id=192 data-nosnippet>192</a>///
<a href=#193 id=193 data-nosnippet>193</a>/// Specifically performing I/O operations outside of Mio on these types (via
<a href=#194 id=194 data-nosnippet>194</a>/// the raw fd) has unspecified behaviour. It could cause no more events to be
<a href=#195 id=195 data-nosnippet>195</a>/// generated for the type even though it returned `WouldBlock` (in an operation
<a href=#196 id=196 data-nosnippet>196</a>/// directly accessing the fd). The behaviour is OS specific and Mio can only
<a href=#197 id=197 data-nosnippet>197</a>/// guarantee cross-platform behaviour if it can control the I/O.
<a href=#198 id=198 data-nosnippet>198</a>///
<a href=#199 id=199 data-nosnippet>199</a>/// [mio-aio]: https://github.com/asomers/mio-aio
<a href=#200 id=200 data-nosnippet>200</a>///
<a href=#201 id=201 data-nosnippet>201</a>/// *The following is **not** guaranteed, just a description of the current
<a href=#202 id=202 data-nosnippet>202</a>/// situation!* Mio is allowed to change the following without it being considered
<a href=#203 id=203 data-nosnippet>203</a>/// a breaking change, don't depend on this, it's just here to inform the user.
<a href=#204 id=204 data-nosnippet>204</a>/// Currently the kqueue and epoll implementation support direct I/O operations
<a href=#205 id=205 data-nosnippet>205</a>/// on the fd without Mio's knowledge. Windows however needs **all** I/O
<a href=#206 id=206 data-nosnippet>206</a>/// operations to go through Mio otherwise it is not able to update it's
<a href=#207 id=207 data-nosnippet>207</a>/// internal state properly and won't generate events.
<a href=#208 id=208 data-nosnippet>208</a>///
<a href=#209 id=209 data-nosnippet>209</a>/// ### Polling without registering event sources
<a href=#210 id=210 data-nosnippet>210</a>///
<a href=#211 id=211 data-nosnippet>211</a>///
<a href=#212 id=212 data-nosnippet>212</a>/// *The following is **not** guaranteed, just a description of the current
<a href=#213 id=213 data-nosnippet>213</a>/// situation!* Mio is allowed to change the following without it being
<a href=#214 id=214 data-nosnippet>214</a>/// considered a breaking change, don't depend on this, it's just here to inform
<a href=#215 id=215 data-nosnippet>215</a>/// the user. On platforms that use epoll, kqueue or IOCP (see implementation
<a href=#216 id=216 data-nosnippet>216</a>/// notes below) polling without previously registering [event sources] will
<a href=#217 id=217 data-nosnippet>217</a>/// result in sleeping forever, only a process signal will be able to wake up
<a href=#218 id=218 data-nosnippet>218</a>/// the thread.
<a href=#219 id=219 data-nosnippet>219</a>///
<a href=#220 id=220 data-nosnippet>220</a>/// On WASM/WASI this is different as it doesn't support process signals,
<a href=#221 id=221 data-nosnippet>221</a>/// furthermore the WASI specification doesn't specify a behaviour in this
<a href=#222 id=222 data-nosnippet>222</a>/// situation, thus it's up to the implementation what to do here. As an
<a href=#223 id=223 data-nosnippet>223</a>/// example, the wasmtime runtime will return `EINVAL` in this situation, but
<a href=#224 id=224 data-nosnippet>224</a>/// different runtimes may return different results. If you have further
<a href=#225 id=225 data-nosnippet>225</a>/// insights or thoughts about this situation (and/or how Mio should handle it)
<a href=#226 id=226 data-nosnippet>226</a>/// please add you comment to [pull request#1580].
<a href=#227 id=227 data-nosnippet>227</a>///
<a href=#228 id=228 data-nosnippet>228</a>/// [event sources]: crate::event::Source
<a href=#229 id=229 data-nosnippet>229</a>/// [pull request#1580]: https://github.com/tokio-rs/mio/pull/1580
<a href=#230 id=230 data-nosnippet>230</a>///
<a href=#231 id=231 data-nosnippet>231</a>/// # Implementation notes
<a href=#232 id=232 data-nosnippet>232</a>///
<a href=#233 id=233 data-nosnippet>233</a>/// `Poll` is backed by the selector provided by the operating system.
<a href=#234 id=234 data-nosnippet>234</a>///
<a href=#235 id=235 data-nosnippet>235</a>/// | OS | Selector |
<a href=#236 id=236 data-nosnippet>236</a>/// |---------------|-----------|
<a href=#237 id=237 data-nosnippet>237</a>/// | Android | [epoll] |
<a href=#238 id=238 data-nosnippet>238</a>/// | DragonFly BSD | [kqueue] |
<a href=#239 id=239 data-nosnippet>239</a>/// | FreeBSD | [kqueue] |
<a href=#240 id=240 data-nosnippet>240</a>/// | iOS | [kqueue] |
<a href=#241 id=241 data-nosnippet>241</a>/// | illumos | [epoll] |
<a href=#242 id=242 data-nosnippet>242</a>/// | Linux | [epoll] |
<a href=#243 id=243 data-nosnippet>243</a>/// | NetBSD | [kqueue] |
<a href=#244 id=244 data-nosnippet>244</a>/// | OpenBSD | [kqueue] |
<a href=#245 id=245 data-nosnippet>245</a>/// | Windows | [IOCP] |
<a href=#246 id=246 data-nosnippet>246</a>/// | macOS | [kqueue] |
<a href=#247 id=247 data-nosnippet>247</a>///
<a href=#248 id=248 data-nosnippet>248</a>/// On all supported platforms, socket operations are handled by using the
<a href=#249 id=249 data-nosnippet>249</a>/// system selector. Platform specific extensions (e.g. [`SourceFd`]) allow
<a href=#250 id=250 data-nosnippet>250</a>/// accessing other features provided by individual system selectors. For
<a href=#251 id=251 data-nosnippet>251</a>/// example, Linux's [`signalfd`] feature can be used by registering the FD with
<a href=#252 id=252 data-nosnippet>252</a>/// `Poll` via [`SourceFd`].
<a href=#253 id=253 data-nosnippet>253</a>///
<a href=#254 id=254 data-nosnippet>254</a>/// On all platforms except windows, a call to [`Poll::poll`] is mostly just a
<a href=#255 id=255 data-nosnippet>255</a>/// direct call to the system selector. However, [IOCP] uses a completion model
<a href=#256 id=256 data-nosnippet>256</a>/// instead of a readiness model. In this case, `Poll` must adapt the completion
<a href=#257 id=257 data-nosnippet>257</a>/// model Mio's API. While non-trivial, the bridge layer is still quite
<a href=#258 id=258 data-nosnippet>258</a>/// efficient. The most expensive part being calls to `read` and `write` require
<a href=#259 id=259 data-nosnippet>259</a>/// data to be copied into an intermediate buffer before it is passed to the
<a href=#260 id=260 data-nosnippet>260</a>/// kernel.
<a href=#261 id=261 data-nosnippet>261</a>///
<a href=#262 id=262 data-nosnippet>262</a>/// [epoll]: https://man7.org/linux/man-pages/man7/epoll.7.html
<a href=#263 id=263 data-nosnippet>263</a>/// [kqueue]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&amp;sektion=2
<a href=#264 id=264 data-nosnippet>264</a>/// [IOCP]: https://docs.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports
<a href=#265 id=265 data-nosnippet>265</a>/// [`signalfd`]: https://man7.org/linux/man-pages/man2/signalfd.2.html
<a href=#266 id=266 data-nosnippet>266</a>/// [`SourceFd`]: unix/struct.SourceFd.html
<a href=#267 id=267 data-nosnippet>267</a>/// [`Poll::poll`]: struct.Poll.html#method.poll
<a href=#268 id=268 data-nosnippet>268</a></span><span class="kw">pub struct </span>Poll {
<a href=#269 id=269 data-nosnippet>269</a> registry: Registry,
<a href=#270 id=270 data-nosnippet>270</a>}
<a href=#271 id=271 data-nosnippet>271</a>
<a href=#272 id=272 data-nosnippet>272</a><span class="doccomment">/// Registers I/O resources.
<a href=#273 id=273 data-nosnippet>273</a></span><span class="kw">pub struct </span>Registry {
<a href=#274 id=274 data-nosnippet>274</a> selector: sys::Selector,
<a href=#275 id=275 data-nosnippet>275</a> <span class="doccomment">/// Whether this selector currently has an associated waker.
<a href=#276 id=276 data-nosnippet>276</a> </span><span class="attr">#[cfg(all(debug_assertions, not(target_os = <span class="string">"wasi"</span>)))]
<a href=#277 id=277 data-nosnippet>277</a> </span>has_waker: Arc&lt;AtomicBool&gt;,
<a href=#278 id=278 data-nosnippet>278</a>}
<a href=#279 id=279 data-nosnippet>279</a>
<a href=#280 id=280 data-nosnippet>280</a><span class="kw">impl </span>Poll {
<a href=#281 id=281 data-nosnippet>281</a> <span class="macro">cfg_os_poll!</span> {
<a href=#282 id=282 data-nosnippet>282</a> <span class="doccomment">/// Return a new `Poll` handle.
<a href=#283 id=283 data-nosnippet>283</a> ///
<a href=#284 id=284 data-nosnippet>284</a> /// This function will make a syscall to the operating system to create
<a href=#285 id=285 data-nosnippet>285</a> /// the system selector. If this syscall fails, `Poll::new` will return
<a href=#286 id=286 data-nosnippet>286</a> /// with the error.
<a href=#287 id=287 data-nosnippet>287</a> ///
<a href=#288 id=288 data-nosnippet>288</a> /// close-on-exec flag is set on the file descriptors used by the selector to prevent
<a href=#289 id=289 data-nosnippet>289</a> /// leaking it to executed processes. However, on some systems such as
<a href=#290 id=290 data-nosnippet>290</a> /// old Linux systems that don't support `epoll_create1` syscall it is done
<a href=#291 id=291 data-nosnippet>291</a> /// non-atomically, so a separate thread executing in parallel to this
<a href=#292 id=292 data-nosnippet>292</a> /// function may accidentally leak the file descriptor if it executes a
<a href=#293 id=293 data-nosnippet>293</a> /// new process before this function returns.
<a href=#294 id=294 data-nosnippet>294</a> ///
<a href=#295 id=295 data-nosnippet>295</a> /// See [struct] level docs for more details.
<a href=#296 id=296 data-nosnippet>296</a> ///
<a href=#297 id=297 data-nosnippet>297</a> /// [struct]: struct.Poll.html
<a href=#298 id=298 data-nosnippet>298</a> ///
<a href=#299 id=299 data-nosnippet>299</a> /// # Examples
<a href=#300 id=300 data-nosnippet>300</a> ///
<a href=#301 id=301 data-nosnippet>301</a> /// ```
<a href=#302 id=302 data-nosnippet>302</a> /// # use std::error::Error;
<a href=#303 id=303 data-nosnippet>303</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#304 id=304 data-nosnippet>304</a> /// use mio::{Poll, Events};
<a href=#305 id=305 data-nosnippet>305</a> /// use std::time::Duration;
<a href=#306 id=306 data-nosnippet>306</a> ///
<a href=#307 id=307 data-nosnippet>307</a> /// let mut poll = match Poll::new() {
<a href=#308 id=308 data-nosnippet>308</a> /// Ok(poll) =&gt; poll,
<a href=#309 id=309 data-nosnippet>309</a> /// Err(e) =&gt; panic!("failed to create Poll instance; err={:?}", e),
<a href=#310 id=310 data-nosnippet>310</a> /// };
<a href=#311 id=311 data-nosnippet>311</a> ///
<a href=#312 id=312 data-nosnippet>312</a> /// // Create a structure to receive polled events
<a href=#313 id=313 data-nosnippet>313</a> /// let mut events = Events::with_capacity(1024);
<a href=#314 id=314 data-nosnippet>314</a> ///
<a href=#315 id=315 data-nosnippet>315</a> /// // Wait for events, but none will be received because no
<a href=#316 id=316 data-nosnippet>316</a> /// // `event::Source`s have been registered with this `Poll` instance.
<a href=#317 id=317 data-nosnippet>317</a> /// poll.poll(&amp;mut events, Some(Duration::from_millis(500)))?;
<a href=#318 id=318 data-nosnippet>318</a> /// assert!(events.is_empty());
<a href=#319 id=319 data-nosnippet>319</a> /// # Ok(())
<a href=#320 id=320 data-nosnippet>320</a> /// # }
<a href=#321 id=321 data-nosnippet>321</a> /// ```
<a href=#322 id=322 data-nosnippet>322</a> </span><span class="kw">pub fn </span>new() -&gt; io::Result&lt;Poll&gt; {
<a href=#323 id=323 data-nosnippet>323</a> sys::Selector::new().map(|selector| Poll {
<a href=#324 id=324 data-nosnippet>324</a> registry: Registry {
<a href=#325 id=325 data-nosnippet>325</a> selector,
<a href=#326 id=326 data-nosnippet>326</a> <span class="attr">#[cfg(all(debug_assertions, not(target_os = <span class="string">"wasi"</span>)))]
<a href=#327 id=327 data-nosnippet>327</a> </span>has_waker: Arc::new(AtomicBool::new(<span class="bool-val">false</span>)),
<a href=#328 id=328 data-nosnippet>328</a> },
<a href=#329 id=329 data-nosnippet>329</a> })
<a href=#330 id=330 data-nosnippet>330</a> }
<a href=#331 id=331 data-nosnippet>331</a> }
<a href=#332 id=332 data-nosnippet>332</a>
<a href=#333 id=333 data-nosnippet>333</a> <span class="doccomment">/// Returns a `Registry` which can be used to register
<a href=#334 id=334 data-nosnippet>334</a> /// `event::Source`s.
<a href=#335 id=335 data-nosnippet>335</a> </span><span class="kw">pub fn </span>registry(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Registry {
<a href=#336 id=336 data-nosnippet>336</a> <span class="kw-2">&amp;</span><span class="self">self</span>.registry
<a href=#337 id=337 data-nosnippet>337</a> }
<a href=#338 id=338 data-nosnippet>338</a>
<a href=#339 id=339 data-nosnippet>339</a> <span class="doccomment">/// Wait for readiness events
<a href=#340 id=340 data-nosnippet>340</a> ///
<a href=#341 id=341 data-nosnippet>341</a> /// Blocks the current thread and waits for readiness events for any of the
<a href=#342 id=342 data-nosnippet>342</a> /// [`event::Source`]s that have been registered with this `Poll` instance.
<a href=#343 id=343 data-nosnippet>343</a> /// The function will block until either at least one readiness event has
<a href=#344 id=344 data-nosnippet>344</a> /// been received or `timeout` has elapsed. A `timeout` of `None` means that
<a href=#345 id=345 data-nosnippet>345</a> /// `poll` will block until a readiness event has been received.
<a href=#346 id=346 data-nosnippet>346</a> ///
<a href=#347 id=347 data-nosnippet>347</a> /// The supplied `events` will be cleared and newly received readiness events
<a href=#348 id=348 data-nosnippet>348</a> /// will be pushed onto the end. At most `events.capacity()` events will be
<a href=#349 id=349 data-nosnippet>349</a> /// returned. If there are further pending readiness events, they will be
<a href=#350 id=350 data-nosnippet>350</a> /// returned on the next call to `poll`.
<a href=#351 id=351 data-nosnippet>351</a> ///
<a href=#352 id=352 data-nosnippet>352</a> /// A single call to `poll` may result in multiple readiness events being
<a href=#353 id=353 data-nosnippet>353</a> /// returned for a single event source. For example, if a TCP socket becomes
<a href=#354 id=354 data-nosnippet>354</a> /// both readable and writable, it may be possible for a single readiness
<a href=#355 id=355 data-nosnippet>355</a> /// event to be returned with both [`readable`] and [`writable`] readiness
<a href=#356 id=356 data-nosnippet>356</a> /// **OR** two separate events may be returned, one with [`readable`] set
<a href=#357 id=357 data-nosnippet>357</a> /// and one with [`writable`] set.
<a href=#358 id=358 data-nosnippet>358</a> ///
<a href=#359 id=359 data-nosnippet>359</a> /// Note that the `timeout` will be rounded up to the system clock
<a href=#360 id=360 data-nosnippet>360</a> /// granularity (usually 1ms), and kernel scheduling delays mean that
<a href=#361 id=361 data-nosnippet>361</a> /// the blocking interval may be overrun by a small amount.
<a href=#362 id=362 data-nosnippet>362</a> ///
<a href=#363 id=363 data-nosnippet>363</a> /// See the [struct] level documentation for a higher level discussion of
<a href=#364 id=364 data-nosnippet>364</a> /// polling.
<a href=#365 id=365 data-nosnippet>365</a> ///
<a href=#366 id=366 data-nosnippet>366</a> /// [`event::Source`]: ./event/trait.Source.html
<a href=#367 id=367 data-nosnippet>367</a> /// [`readable`]: struct.Interest.html#associatedconstant.READABLE
<a href=#368 id=368 data-nosnippet>368</a> /// [`writable`]: struct.Interest.html#associatedconstant.WRITABLE
<a href=#369 id=369 data-nosnippet>369</a> /// [struct]: struct.Poll.html
<a href=#370 id=370 data-nosnippet>370</a> /// [`iter`]: ./event/struct.Events.html#method.iter
<a href=#371 id=371 data-nosnippet>371</a> ///
<a href=#372 id=372 data-nosnippet>372</a> /// # Notes
<a href=#373 id=373 data-nosnippet>373</a> ///
<a href=#374 id=374 data-nosnippet>374</a> /// This returns any errors without attempting to retry, previous versions
<a href=#375 id=375 data-nosnippet>375</a> /// of Mio would automatically retry the poll call if it was interrupted
<a href=#376 id=376 data-nosnippet>376</a> /// (if `EINTR` was returned).
<a href=#377 id=377 data-nosnippet>377</a> ///
<a href=#378 id=378 data-nosnippet>378</a> /// Currently if the `timeout` elapses without any readiness events
<a href=#379 id=379 data-nosnippet>379</a> /// triggering this will return `Ok(())`. However we're not guaranteeing
<a href=#380 id=380 data-nosnippet>380</a> /// this behaviour as this depends on the OS.
<a href=#381 id=381 data-nosnippet>381</a> ///
<a href=#382 id=382 data-nosnippet>382</a> /// # Examples
<a href=#383 id=383 data-nosnippet>383</a> ///
<a href=#384 id=384 data-nosnippet>384</a> /// A basic example -- establishing a `TcpStream` connection.
<a href=#385 id=385 data-nosnippet>385</a> ///
<a href=#386 id=386 data-nosnippet>386</a> </span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#387 id=387 data-nosnippet>387</a> #[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#388 id=388 data-nosnippet>388</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#389 id=389 data-nosnippet>389</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#390 id=390 data-nosnippet>390</a> /// use mio::{Events, Poll, Interest, Token};
<a href=#391 id=391 data-nosnippet>391</a> /// use mio::net::TcpStream;
<a href=#392 id=392 data-nosnippet>392</a> ///
<a href=#393 id=393 data-nosnippet>393</a> /// use std::net::{TcpListener, SocketAddr};
<a href=#394 id=394 data-nosnippet>394</a> /// use std::thread;
<a href=#395 id=395 data-nosnippet>395</a> ///
<a href=#396 id=396 data-nosnippet>396</a> /// // Bind a server socket to connect to.
<a href=#397 id=397 data-nosnippet>397</a> /// let addr: SocketAddr = "127.0.0.1:0".parse()?;
<a href=#398 id=398 data-nosnippet>398</a> /// let server = TcpListener::bind(addr)?;
<a href=#399 id=399 data-nosnippet>399</a> /// let addr = server.local_addr()?.clone();
<a href=#400 id=400 data-nosnippet>400</a> ///
<a href=#401 id=401 data-nosnippet>401</a> /// // Spawn a thread to accept the socket
<a href=#402 id=402 data-nosnippet>402</a> /// thread::spawn(move || {
<a href=#403 id=403 data-nosnippet>403</a> /// let _ = server.accept();
<a href=#404 id=404 data-nosnippet>404</a> /// });
<a href=#405 id=405 data-nosnippet>405</a> ///
<a href=#406 id=406 data-nosnippet>406</a> /// // Construct a new `Poll` handle as well as the `Events` we'll store into
<a href=#407 id=407 data-nosnippet>407</a> /// let mut poll = Poll::new()?;
<a href=#408 id=408 data-nosnippet>408</a> /// let mut events = Events::with_capacity(1024);
<a href=#409 id=409 data-nosnippet>409</a> ///
<a href=#410 id=410 data-nosnippet>410</a> /// // Connect the stream
<a href=#411 id=411 data-nosnippet>411</a> /// let mut stream = TcpStream::connect(addr)?;
<a href=#412 id=412 data-nosnippet>412</a> ///
<a href=#413 id=413 data-nosnippet>413</a> /// // Register the stream with `Poll`
<a href=#414 id=414 data-nosnippet>414</a> /// poll.registry().register(
<a href=#415 id=415 data-nosnippet>415</a> /// &amp;mut stream,
<a href=#416 id=416 data-nosnippet>416</a> /// Token(0),
<a href=#417 id=417 data-nosnippet>417</a> /// Interest::READABLE | Interest::WRITABLE)?;
<a href=#418 id=418 data-nosnippet>418</a> ///
<a href=#419 id=419 data-nosnippet>419</a> /// // Wait for the socket to become ready. This has to happens in a loop to
<a href=#420 id=420 data-nosnippet>420</a> /// // handle spurious wakeups.
<a href=#421 id=421 data-nosnippet>421</a> /// loop {
<a href=#422 id=422 data-nosnippet>422</a> /// poll.poll(&amp;mut events, None)?;
<a href=#423 id=423 data-nosnippet>423</a> ///
<a href=#424 id=424 data-nosnippet>424</a> /// for event in &amp;events {
<a href=#425 id=425 data-nosnippet>425</a> /// if event.token() == Token(0) &amp;&amp; event.is_writable() {
<a href=#426 id=426 data-nosnippet>426</a> /// // The socket connected (probably, it could still be a spurious
<a href=#427 id=427 data-nosnippet>427</a> /// // wakeup)
<a href=#428 id=428 data-nosnippet>428</a> /// return Ok(());
<a href=#429 id=429 data-nosnippet>429</a> /// }
<a href=#430 id=430 data-nosnippet>430</a> /// }
<a href=#431 id=431 data-nosnippet>431</a> /// }
<a href=#432 id=432 data-nosnippet>432</a> /// # }
<a href=#433 id=433 data-nosnippet>433</a> /// ```
<a href=#434 id=434 data-nosnippet>434</a> ///
<a href=#435 id=435 data-nosnippet>435</a> /// [struct]: #
<a href=#436 id=436 data-nosnippet>436</a> </span><span class="kw">pub fn </span>poll(<span class="kw-2">&amp;mut </span><span class="self">self</span>, events: <span class="kw-2">&amp;mut </span>Events, timeout: <span class="prelude-ty">Option</span>&lt;Duration&gt;) -&gt; io::Result&lt;()&gt; {
<a href=#437 id=437 data-nosnippet>437</a> <span class="self">self</span>.registry.selector.select(events.sys(), timeout)
<a href=#438 id=438 data-nosnippet>438</a> }
<a href=#439 id=439 data-nosnippet>439</a>}
<a href=#440 id=440 data-nosnippet>440</a>
<a href=#441 id=441 data-nosnippet>441</a><span class="attr">#[cfg(all(
<a href=#442 id=442 data-nosnippet>442</a> unix,
<a href=#443 id=443 data-nosnippet>443</a> not(mio_unsupported_force_poll_poll),
<a href=#444 id=444 data-nosnippet>444</a> not(any(
<a href=#445 id=445 data-nosnippet>445</a> target_os = <span class="string">"aix"</span>,
<a href=#446 id=446 data-nosnippet>446</a> target_os = <span class="string">"espidf"</span>,
<a href=#447 id=447 data-nosnippet>447</a> target_os = <span class="string">"fuchsia"</span>,
<a href=#448 id=448 data-nosnippet>448</a> target_os = <span class="string">"haiku"</span>,
<a href=#449 id=449 data-nosnippet>449</a> target_os = <span class="string">"hermit"</span>,
<a href=#450 id=450 data-nosnippet>450</a> target_os = <span class="string">"hurd"</span>,
<a href=#451 id=451 data-nosnippet>451</a> target_os = <span class="string">"nto"</span>,
<a href=#452 id=452 data-nosnippet>452</a> target_os = <span class="string">"solaris"</span>,
<a href=#453 id=453 data-nosnippet>453</a> target_os = <span class="string">"vita"</span>,
<a href=#454 id=454 data-nosnippet>454</a> target_os = <span class="string">"cygwin"</span>,
<a href=#455 id=455 data-nosnippet>455</a> )),
<a href=#456 id=456 data-nosnippet>456</a>))]
<a href=#457 id=457 data-nosnippet>457</a></span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>Poll {
<a href=#458 id=458 data-nosnippet>458</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#459 id=459 data-nosnippet>459</a> <span class="self">self</span>.registry.as_raw_fd()
<a href=#460 id=460 data-nosnippet>460</a> }
<a href=#461 id=461 data-nosnippet>461</a>}
<a href=#462 id=462 data-nosnippet>462</a>
<a href=#463 id=463 data-nosnippet>463</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Poll {
<a href=#464 id=464 data-nosnippet>464</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#465 id=465 data-nosnippet>465</a> fmt.debug_struct(<span class="string">"Poll"</span>).finish()
<a href=#466 id=466 data-nosnippet>466</a> }
<a href=#467 id=467 data-nosnippet>467</a>}
<a href=#468 id=468 data-nosnippet>468</a>
<a href=#469 id=469 data-nosnippet>469</a><span class="kw">impl </span>Registry {
<a href=#470 id=470 data-nosnippet>470</a> <span class="doccomment">/// Register an [`event::Source`] with the `Poll` instance.
<a href=#471 id=471 data-nosnippet>471</a> ///
<a href=#472 id=472 data-nosnippet>472</a> /// Once registered, the `Poll` instance will monitor the event source for
<a href=#473 id=473 data-nosnippet>473</a> /// readiness state changes. When it notices a state change, it will return
<a href=#474 id=474 data-nosnippet>474</a> /// a readiness event for the handle the next time [`poll`] is called.
<a href=#475 id=475 data-nosnippet>475</a> ///
<a href=#476 id=476 data-nosnippet>476</a> /// See [`Poll`] docs for a high level overview.
<a href=#477 id=477 data-nosnippet>477</a> ///
<a href=#478 id=478 data-nosnippet>478</a> /// # Arguments
<a href=#479 id=479 data-nosnippet>479</a> ///
<a href=#480 id=480 data-nosnippet>480</a> /// `source: &amp;mut S: event::Source`: This is the source of events that the
<a href=#481 id=481 data-nosnippet>481</a> /// `Poll` instance should monitor for readiness state changes.
<a href=#482 id=482 data-nosnippet>482</a> ///
<a href=#483 id=483 data-nosnippet>483</a> /// `token: Token`: The caller picks a token to associate with the socket.
<a href=#484 id=484 data-nosnippet>484</a> /// When [`poll`] returns an event for the handle, this token is included.
<a href=#485 id=485 data-nosnippet>485</a> /// This allows the caller to map the event to its source. The token
<a href=#486 id=486 data-nosnippet>486</a> /// associated with the `event::Source` can be changed at any time by
<a href=#487 id=487 data-nosnippet>487</a> /// calling [`reregister`].
<a href=#488 id=488 data-nosnippet>488</a> ///
<a href=#489 id=489 data-nosnippet>489</a> /// See documentation on [`Token`] for an example showing how to pick
<a href=#490 id=490 data-nosnippet>490</a> /// [`Token`] values.
<a href=#491 id=491 data-nosnippet>491</a> ///
<a href=#492 id=492 data-nosnippet>492</a> /// `interest: Interest`: Specifies which operations `Poll` should monitor
<a href=#493 id=493 data-nosnippet>493</a> /// for readiness. `Poll` will only return readiness events for operations
<a href=#494 id=494 data-nosnippet>494</a> /// specified by this argument.
<a href=#495 id=495 data-nosnippet>495</a> ///
<a href=#496 id=496 data-nosnippet>496</a> /// If a socket is registered with readable interest and the socket becomes
<a href=#497 id=497 data-nosnippet>497</a> /// writable, no event will be returned from [`poll`].
<a href=#498 id=498 data-nosnippet>498</a> ///
<a href=#499 id=499 data-nosnippet>499</a> /// The readiness interest for an `event::Source` can be changed at any time
<a href=#500 id=500 data-nosnippet>500</a> /// by calling [`reregister`].
<a href=#501 id=501 data-nosnippet>501</a> ///
<a href=#502 id=502 data-nosnippet>502</a> /// # Notes
<a href=#503 id=503 data-nosnippet>503</a> ///
<a href=#504 id=504 data-nosnippet>504</a> /// Callers must ensure that if a source being registered with a `Poll`
<a href=#505 id=505 data-nosnippet>505</a> /// instance was previously registered with that `Poll` instance, then a
<a href=#506 id=506 data-nosnippet>506</a> /// call to [`deregister`] has already occurred. Consecutive calls to
<a href=#507 id=507 data-nosnippet>507</a> /// `register` is unspecified behavior.
<a href=#508 id=508 data-nosnippet>508</a> ///
<a href=#509 id=509 data-nosnippet>509</a> /// Unless otherwise specified, the caller should assume that once an event
<a href=#510 id=510 data-nosnippet>510</a> /// source is registered with a `Poll` instance, it is bound to that `Poll`
<a href=#511 id=511 data-nosnippet>511</a> /// instance for the lifetime of the event source. This remains true even
<a href=#512 id=512 data-nosnippet>512</a> /// if the event source is deregistered from the poll instance using
<a href=#513 id=513 data-nosnippet>513</a> /// [`deregister`].
<a href=#514 id=514 data-nosnippet>514</a> ///
<a href=#515 id=515 data-nosnippet>515</a> /// [`event::Source`]: ./event/trait.Source.html
<a href=#516 id=516 data-nosnippet>516</a> /// [`poll`]: struct.Poll.html#method.poll
<a href=#517 id=517 data-nosnippet>517</a> /// [`reregister`]: struct.Registry.html#method.reregister
<a href=#518 id=518 data-nosnippet>518</a> /// [`deregister`]: struct.Registry.html#method.deregister
<a href=#519 id=519 data-nosnippet>519</a> /// [`Token`]: struct.Token.html
<a href=#520 id=520 data-nosnippet>520</a> ///
<a href=#521 id=521 data-nosnippet>521</a> /// # Examples
<a href=#522 id=522 data-nosnippet>522</a> ///
<a href=#523 id=523 data-nosnippet>523</a> </span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#524 id=524 data-nosnippet>524</a> #[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#525 id=525 data-nosnippet>525</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#526 id=526 data-nosnippet>526</a> /// # use std::net;
<a href=#527 id=527 data-nosnippet>527</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#528 id=528 data-nosnippet>528</a> /// use mio::{Events, Poll, Interest, Token};
<a href=#529 id=529 data-nosnippet>529</a> /// use mio::net::TcpStream;
<a href=#530 id=530 data-nosnippet>530</a> /// use std::net::SocketAddr;
<a href=#531 id=531 data-nosnippet>531</a> /// use std::time::{Duration, Instant};
<a href=#532 id=532 data-nosnippet>532</a> ///
<a href=#533 id=533 data-nosnippet>533</a> /// let mut poll = Poll::new()?;
<a href=#534 id=534 data-nosnippet>534</a> ///
<a href=#535 id=535 data-nosnippet>535</a> /// let address: SocketAddr = "127.0.0.1:0".parse()?;
<a href=#536 id=536 data-nosnippet>536</a> /// let listener = net::TcpListener::bind(address)?;
<a href=#537 id=537 data-nosnippet>537</a> /// let mut socket = TcpStream::connect(listener.local_addr()?)?;
<a href=#538 id=538 data-nosnippet>538</a> ///
<a href=#539 id=539 data-nosnippet>539</a> /// // Register the socket with `poll`
<a href=#540 id=540 data-nosnippet>540</a> /// poll.registry().register(
<a href=#541 id=541 data-nosnippet>541</a> /// &amp;mut socket,
<a href=#542 id=542 data-nosnippet>542</a> /// Token(0),
<a href=#543 id=543 data-nosnippet>543</a> /// Interest::READABLE | Interest::WRITABLE)?;
<a href=#544 id=544 data-nosnippet>544</a> ///
<a href=#545 id=545 data-nosnippet>545</a> /// let mut events = Events::with_capacity(1024);
<a href=#546 id=546 data-nosnippet>546</a> /// let start = Instant::now();
<a href=#547 id=547 data-nosnippet>547</a> /// let timeout = Duration::from_millis(500);
<a href=#548 id=548 data-nosnippet>548</a> ///
<a href=#549 id=549 data-nosnippet>549</a> /// loop {
<a href=#550 id=550 data-nosnippet>550</a> /// let elapsed = start.elapsed();
<a href=#551 id=551 data-nosnippet>551</a> ///
<a href=#552 id=552 data-nosnippet>552</a> /// if elapsed &gt;= timeout {
<a href=#553 id=553 data-nosnippet>553</a> /// // Connection timed out
<a href=#554 id=554 data-nosnippet>554</a> /// return Ok(());
<a href=#555 id=555 data-nosnippet>555</a> /// }
<a href=#556 id=556 data-nosnippet>556</a> ///
<a href=#557 id=557 data-nosnippet>557</a> /// let remaining = timeout - elapsed;
<a href=#558 id=558 data-nosnippet>558</a> /// poll.poll(&amp;mut events, Some(remaining))?;
<a href=#559 id=559 data-nosnippet>559</a> ///
<a href=#560 id=560 data-nosnippet>560</a> /// for event in &amp;events {
<a href=#561 id=561 data-nosnippet>561</a> /// if event.token() == Token(0) {
<a href=#562 id=562 data-nosnippet>562</a> /// // Something (probably) happened on the socket.
<a href=#563 id=563 data-nosnippet>563</a> /// return Ok(());
<a href=#564 id=564 data-nosnippet>564</a> /// }
<a href=#565 id=565 data-nosnippet>565</a> /// }
<a href=#566 id=566 data-nosnippet>566</a> /// }
<a href=#567 id=567 data-nosnippet>567</a> /// # }
<a href=#568 id=568 data-nosnippet>568</a> /// ```
<a href=#569 id=569 data-nosnippet>569</a> </span><span class="kw">pub fn </span>register&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, source: <span class="kw-2">&amp;mut </span>S, token: Token, interests: Interest) -&gt; io::Result&lt;()&gt;
<a href=#570 id=570 data-nosnippet>570</a> <span class="kw">where
<a href=#571 id=571 data-nosnippet>571</a> </span>S: event::Source + <span class="question-mark">?</span>Sized,
<a href=#572 id=572 data-nosnippet>572</a> {
<a href=#573 id=573 data-nosnippet>573</a> <span class="macro">trace!</span>(
<a href=#574 id=574 data-nosnippet>574</a> <span class="string">"registering event source with poller: token={:?}, interests={:?}"</span>,
<a href=#575 id=575 data-nosnippet>575</a> token,
<a href=#576 id=576 data-nosnippet>576</a> interests
<a href=#577 id=577 data-nosnippet>577</a> );
<a href=#578 id=578 data-nosnippet>578</a> source.register(<span class="self">self</span>, token, interests)
<a href=#579 id=579 data-nosnippet>579</a> }
<a href=#580 id=580 data-nosnippet>580</a>
<a href=#581 id=581 data-nosnippet>581</a> <span class="doccomment">/// Re-register an [`event::Source`] with the `Poll` instance.
<a href=#582 id=582 data-nosnippet>582</a> ///
<a href=#583 id=583 data-nosnippet>583</a> /// Re-registering an event source allows changing the details of the
<a href=#584 id=584 data-nosnippet>584</a> /// registration. Specifically, it allows updating the associated `token`
<a href=#585 id=585 data-nosnippet>585</a> /// and `interests` specified in previous `register` and `reregister` calls.
<a href=#586 id=586 data-nosnippet>586</a> ///
<a href=#587 id=587 data-nosnippet>587</a> /// The `reregister` arguments fully override the previous values. In other
<a href=#588 id=588 data-nosnippet>588</a> /// words, if a socket is registered with [`readable`] interest and the call
<a href=#589 id=589 data-nosnippet>589</a> /// to `reregister` specifies [`writable`], then read interest is no longer
<a href=#590 id=590 data-nosnippet>590</a> /// requested for the handle.
<a href=#591 id=591 data-nosnippet>591</a> ///
<a href=#592 id=592 data-nosnippet>592</a> /// The event source must have previously been registered with this instance
<a href=#593 id=593 data-nosnippet>593</a> /// of `Poll`, otherwise the behavior is unspecified.
<a href=#594 id=594 data-nosnippet>594</a> ///
<a href=#595 id=595 data-nosnippet>595</a> /// See the [`register`] documentation for details about the function
<a href=#596 id=596 data-nosnippet>596</a> /// arguments and see the [`struct`] docs for a high level overview of
<a href=#597 id=597 data-nosnippet>597</a> /// polling.
<a href=#598 id=598 data-nosnippet>598</a> ///
<a href=#599 id=599 data-nosnippet>599</a> /// # Examples
<a href=#600 id=600 data-nosnippet>600</a> ///
<a href=#601 id=601 data-nosnippet>601</a> </span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#602 id=602 data-nosnippet>602</a> #[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#603 id=603 data-nosnippet>603</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#604 id=604 data-nosnippet>604</a> /// # use std::net;
<a href=#605 id=605 data-nosnippet>605</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#606 id=606 data-nosnippet>606</a> /// use mio::{Poll, Interest, Token};
<a href=#607 id=607 data-nosnippet>607</a> /// use mio::net::TcpStream;
<a href=#608 id=608 data-nosnippet>608</a> /// use std::net::SocketAddr;
<a href=#609 id=609 data-nosnippet>609</a> ///
<a href=#610 id=610 data-nosnippet>610</a> /// let poll = Poll::new()?;
<a href=#611 id=611 data-nosnippet>611</a> ///
<a href=#612 id=612 data-nosnippet>612</a> /// let address: SocketAddr = "127.0.0.1:0".parse()?;
<a href=#613 id=613 data-nosnippet>613</a> /// let listener = net::TcpListener::bind(address)?;
<a href=#614 id=614 data-nosnippet>614</a> /// let mut socket = TcpStream::connect(listener.local_addr()?)?;
<a href=#615 id=615 data-nosnippet>615</a> ///
<a href=#616 id=616 data-nosnippet>616</a> /// // Register the socket with `poll`, requesting readable
<a href=#617 id=617 data-nosnippet>617</a> /// poll.registry().register(
<a href=#618 id=618 data-nosnippet>618</a> /// &amp;mut socket,
<a href=#619 id=619 data-nosnippet>619</a> /// Token(0),
<a href=#620 id=620 data-nosnippet>620</a> /// Interest::READABLE)?;
<a href=#621 id=621 data-nosnippet>621</a> ///
<a href=#622 id=622 data-nosnippet>622</a> /// // Reregister the socket specifying write interest instead. Even though
<a href=#623 id=623 data-nosnippet>623</a> /// // the token is the same it must be specified.
<a href=#624 id=624 data-nosnippet>624</a> /// poll.registry().reregister(
<a href=#625 id=625 data-nosnippet>625</a> /// &amp;mut socket,
<a href=#626 id=626 data-nosnippet>626</a> /// Token(0),
<a href=#627 id=627 data-nosnippet>627</a> /// Interest::WRITABLE)?;
<a href=#628 id=628 data-nosnippet>628</a> /// # Ok(())
<a href=#629 id=629 data-nosnippet>629</a> /// # }
<a href=#630 id=630 data-nosnippet>630</a> /// ```
<a href=#631 id=631 data-nosnippet>631</a> ///
<a href=#632 id=632 data-nosnippet>632</a> /// [`event::Source`]: ./event/trait.Source.html
<a href=#633 id=633 data-nosnippet>633</a> /// [`struct`]: struct.Poll.html
<a href=#634 id=634 data-nosnippet>634</a> /// [`register`]: struct.Registry.html#method.register
<a href=#635 id=635 data-nosnippet>635</a> /// [`readable`]: ./event/struct.Event.html#is_readable
<a href=#636 id=636 data-nosnippet>636</a> /// [`writable`]: ./event/struct.Event.html#is_writable
<a href=#637 id=637 data-nosnippet>637</a> </span><span class="kw">pub fn </span>reregister&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, source: <span class="kw-2">&amp;mut </span>S, token: Token, interests: Interest) -&gt; io::Result&lt;()&gt;
<a href=#638 id=638 data-nosnippet>638</a> <span class="kw">where
<a href=#639 id=639 data-nosnippet>639</a> </span>S: event::Source + <span class="question-mark">?</span>Sized,
<a href=#640 id=640 data-nosnippet>640</a> {
<a href=#641 id=641 data-nosnippet>641</a> <span class="macro">trace!</span>(
<a href=#642 id=642 data-nosnippet>642</a> <span class="string">"reregistering event source with poller: token={:?}, interests={:?}"</span>,
<a href=#643 id=643 data-nosnippet>643</a> token,
<a href=#644 id=644 data-nosnippet>644</a> interests
<a href=#645 id=645 data-nosnippet>645</a> );
<a href=#646 id=646 data-nosnippet>646</a> source.reregister(<span class="self">self</span>, token, interests)
<a href=#647 id=647 data-nosnippet>647</a> }
<a href=#648 id=648 data-nosnippet>648</a>
<a href=#649 id=649 data-nosnippet>649</a> <span class="doccomment">/// Deregister an [`event::Source`] with the `Poll` instance.
<a href=#650 id=650 data-nosnippet>650</a> ///
<a href=#651 id=651 data-nosnippet>651</a> /// When an event source is deregistered, the `Poll` instance will no longer
<a href=#652 id=652 data-nosnippet>652</a> /// monitor it for readiness state changes. Deregistering clears up any
<a href=#653 id=653 data-nosnippet>653</a> /// internal resources needed to track the handle. After an explicit call
<a href=#654 id=654 data-nosnippet>654</a> /// to this method completes, it is guaranteed that the token previously
<a href=#655 id=655 data-nosnippet>655</a> /// registered to this handle will not be returned by a future poll, so long
<a href=#656 id=656 data-nosnippet>656</a> /// as a happens-before relationship is established between this call and
<a href=#657 id=657 data-nosnippet>657</a> /// the poll.
<a href=#658 id=658 data-nosnippet>658</a> ///
<a href=#659 id=659 data-nosnippet>659</a> /// The event source must have previously been registered with this instance
<a href=#660 id=660 data-nosnippet>660</a> /// of `Poll`, otherwise the behavior is unspecified.
<a href=#661 id=661 data-nosnippet>661</a> ///
<a href=#662 id=662 data-nosnippet>662</a> /// A handle can be passed back to `register` after it has been
<a href=#663 id=663 data-nosnippet>663</a> /// deregistered; however, it must be passed back to the **same** `Poll`
<a href=#664 id=664 data-nosnippet>664</a> /// instance, otherwise the behavior is unspecified.
<a href=#665 id=665 data-nosnippet>665</a> ///
<a href=#666 id=666 data-nosnippet>666</a> /// # Examples
<a href=#667 id=667 data-nosnippet>667</a> ///
<a href=#668 id=668 data-nosnippet>668</a> </span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#669 id=669 data-nosnippet>669</a> #[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#670 id=670 data-nosnippet>670</a> </span><span class="doccomment">/// # use std::error::Error;
<a href=#671 id=671 data-nosnippet>671</a> /// # use std::net;
<a href=#672 id=672 data-nosnippet>672</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#673 id=673 data-nosnippet>673</a> /// use mio::{Events, Poll, Interest, Token};
<a href=#674 id=674 data-nosnippet>674</a> /// use mio::net::TcpStream;
<a href=#675 id=675 data-nosnippet>675</a> /// use std::net::SocketAddr;
<a href=#676 id=676 data-nosnippet>676</a> /// use std::time::Duration;
<a href=#677 id=677 data-nosnippet>677</a> ///
<a href=#678 id=678 data-nosnippet>678</a> /// let mut poll = Poll::new()?;
<a href=#679 id=679 data-nosnippet>679</a> ///
<a href=#680 id=680 data-nosnippet>680</a> /// let address: SocketAddr = "127.0.0.1:0".parse()?;
<a href=#681 id=681 data-nosnippet>681</a> /// let listener = net::TcpListener::bind(address)?;
<a href=#682 id=682 data-nosnippet>682</a> /// let mut socket = TcpStream::connect(listener.local_addr()?)?;
<a href=#683 id=683 data-nosnippet>683</a> ///
<a href=#684 id=684 data-nosnippet>684</a> /// // Register the socket with `poll`
<a href=#685 id=685 data-nosnippet>685</a> /// poll.registry().register(
<a href=#686 id=686 data-nosnippet>686</a> /// &amp;mut socket,
<a href=#687 id=687 data-nosnippet>687</a> /// Token(0),
<a href=#688 id=688 data-nosnippet>688</a> /// Interest::READABLE)?;
<a href=#689 id=689 data-nosnippet>689</a> ///
<a href=#690 id=690 data-nosnippet>690</a> /// poll.registry().deregister(&amp;mut socket)?;
<a href=#691 id=691 data-nosnippet>691</a> ///
<a href=#692 id=692 data-nosnippet>692</a> /// let mut events = Events::with_capacity(1024);
<a href=#693 id=693 data-nosnippet>693</a> ///
<a href=#694 id=694 data-nosnippet>694</a> /// // Set a timeout because this poll should never receive any events.
<a href=#695 id=695 data-nosnippet>695</a> /// poll.poll(&amp;mut events, Some(Duration::from_secs(1)))?;
<a href=#696 id=696 data-nosnippet>696</a> /// assert!(events.is_empty());
<a href=#697 id=697 data-nosnippet>697</a> /// # Ok(())
<a href=#698 id=698 data-nosnippet>698</a> /// # }
<a href=#699 id=699 data-nosnippet>699</a> /// ```
<a href=#700 id=700 data-nosnippet>700</a> </span><span class="kw">pub fn </span>deregister&lt;S&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, source: <span class="kw-2">&amp;mut </span>S) -&gt; io::Result&lt;()&gt;
<a href=#701 id=701 data-nosnippet>701</a> <span class="kw">where
<a href=#702 id=702 data-nosnippet>702</a> </span>S: event::Source + <span class="question-mark">?</span>Sized,
<a href=#703 id=703 data-nosnippet>703</a> {
<a href=#704 id=704 data-nosnippet>704</a> <span class="macro">trace!</span>(<span class="string">"deregistering event source from poller"</span>);
<a href=#705 id=705 data-nosnippet>705</a> source.deregister(<span class="self">self</span>)
<a href=#706 id=706 data-nosnippet>706</a> }
<a href=#707 id=707 data-nosnippet>707</a>
<a href=#708 id=708 data-nosnippet>708</a> <span class="doccomment">/// Creates a new independently owned `Registry`.
<a href=#709 id=709 data-nosnippet>709</a> ///
<a href=#710 id=710 data-nosnippet>710</a> /// Event sources registered with this `Registry` will be registered with
<a href=#711 id=711 data-nosnippet>711</a> /// the original `Registry` and `Poll` instance.
<a href=#712 id=712 data-nosnippet>712</a> </span><span class="kw">pub fn </span>try_clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;Registry&gt; {
<a href=#713 id=713 data-nosnippet>713</a> <span class="self">self</span>.selector.try_clone().map(|selector| Registry {
<a href=#714 id=714 data-nosnippet>714</a> selector,
<a href=#715 id=715 data-nosnippet>715</a> <span class="attr">#[cfg(all(debug_assertions, not(target_os = <span class="string">"wasi"</span>)))]
<a href=#716 id=716 data-nosnippet>716</a> </span>has_waker: Arc::clone(<span class="kw-2">&amp;</span><span class="self">self</span>.has_waker),
<a href=#717 id=717 data-nosnippet>717</a> })
<a href=#718 id=718 data-nosnippet>718</a> }
<a href=#719 id=719 data-nosnippet>719</a>
<a href=#720 id=720 data-nosnippet>720</a> <span class="doccomment">/// Internal check to ensure only a single `Waker` is active per [`Poll`]
<a href=#721 id=721 data-nosnippet>721</a> /// instance.
<a href=#722 id=722 data-nosnippet>722</a> </span><span class="attr">#[cfg(all(debug_assertions, not(target_os = <span class="string">"wasi"</span>)))]
<a href=#723 id=723 data-nosnippet>723</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>register_waker(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<a href=#724 id=724 data-nosnippet>724</a> <span class="macro">assert!</span>(
<a href=#725 id=725 data-nosnippet>725</a> !<span class="self">self</span>.has_waker.swap(<span class="bool-val">true</span>, Ordering::AcqRel),
<a href=#726 id=726 data-nosnippet>726</a> <span class="string">"Only a single `Waker` can be active per `Poll` instance"
<a href=#727 id=727 data-nosnippet>727</a> </span>);
<a href=#728 id=728 data-nosnippet>728</a> }
<a href=#729 id=729 data-nosnippet>729</a>
<a href=#730 id=730 data-nosnippet>730</a> <span class="doccomment">/// Get access to the `sys::Selector`.
<a href=#731 id=731 data-nosnippet>731</a> </span><span class="attr">#[cfg(any(not(target_os = <span class="string">"wasi"</span>), feature = <span class="string">"net"</span>))]
<a href=#732 id=732 data-nosnippet>732</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>selector(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>sys::Selector {
<a href=#733 id=733 data-nosnippet>733</a> <span class="kw-2">&amp;</span><span class="self">self</span>.selector
<a href=#734 id=734 data-nosnippet>734</a> }
<a href=#735 id=735 data-nosnippet>735</a>}
<a href=#736 id=736 data-nosnippet>736</a>
<a href=#737 id=737 data-nosnippet>737</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Registry {
<a href=#738 id=738 data-nosnippet>738</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#739 id=739 data-nosnippet>739</a> fmt.debug_struct(<span class="string">"Registry"</span>).finish()
<a href=#740 id=740 data-nosnippet>740</a> }
<a href=#741 id=741 data-nosnippet>741</a>}
<a href=#742 id=742 data-nosnippet>742</a>
<a href=#743 id=743 data-nosnippet>743</a><span class="attr">#[cfg(all(
<a href=#744 id=744 data-nosnippet>744</a> unix,
<a href=#745 id=745 data-nosnippet>745</a> not(mio_unsupported_force_poll_poll),
<a href=#746 id=746 data-nosnippet>746</a> not(any(
<a href=#747 id=747 data-nosnippet>747</a> target_os = <span class="string">"aix"</span>,
<a href=#748 id=748 data-nosnippet>748</a> target_os = <span class="string">"espidf"</span>,
<a href=#749 id=749 data-nosnippet>749</a> target_os = <span class="string">"haiku"</span>,
<a href=#750 id=750 data-nosnippet>750</a> target_os = <span class="string">"fuchsia"</span>,
<a href=#751 id=751 data-nosnippet>751</a> target_os = <span class="string">"hermit"</span>,
<a href=#752 id=752 data-nosnippet>752</a> target_os = <span class="string">"hurd"</span>,
<a href=#753 id=753 data-nosnippet>753</a> target_os = <span class="string">"nto"</span>,
<a href=#754 id=754 data-nosnippet>754</a> target_os = <span class="string">"solaris"</span>,
<a href=#755 id=755 data-nosnippet>755</a> target_os = <span class="string">"vita"</span>,
<a href=#756 id=756 data-nosnippet>756</a> target_os = <span class="string">"cygwin"</span>,
<a href=#757 id=757 data-nosnippet>757</a> )),
<a href=#758 id=758 data-nosnippet>758</a>))]
<a href=#759 id=759 data-nosnippet>759</a></span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>Registry {
<a href=#760 id=760 data-nosnippet>760</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#761 id=761 data-nosnippet>761</a> <span class="self">self</span>.selector.as_raw_fd()
<a href=#762 id=762 data-nosnippet>762</a> }
<a href=#763 id=763 data-nosnippet>763</a>}
<a href=#764 id=764 data-nosnippet>764</a>
<a href=#765 id=765 data-nosnippet>765</a><span class="macro">cfg_os_poll!</span> {
<a href=#766 id=766 data-nosnippet>766</a> <span class="attr">#[cfg(all(
<a href=#767 id=767 data-nosnippet>767</a> unix,
<a href=#768 id=768 data-nosnippet>768</a> not(mio_unsupported_force_poll_poll),
<a href=#769 id=769 data-nosnippet>769</a> not(any(
<a href=#770 id=770 data-nosnippet>770</a> target_os = <span class="string">"aix"</span>,
<a href=#771 id=771 data-nosnippet>771</a> target_os = <span class="string">"espidf"</span>,
<a href=#772 id=772 data-nosnippet>772</a> target_os = <span class="string">"hermit"</span>,
<a href=#773 id=773 data-nosnippet>773</a> target_os = <span class="string">"hurd"</span>,
<a href=#774 id=774 data-nosnippet>774</a> target_os = <span class="string">"nto"</span>,
<a href=#775 id=775 data-nosnippet>775</a> target_os = <span class="string">"solaris"</span>,
<a href=#776 id=776 data-nosnippet>776</a> target_os = <span class="string">"vita"</span>,
<a href=#777 id=777 data-nosnippet>777</a> target_os = <span class="string">"cygwin"</span>,
<a href=#778 id=778 data-nosnippet>778</a> )),
<a href=#779 id=779 data-nosnippet>779</a> ))]
<a href=#780 id=780 data-nosnippet>780</a> #[test]
<a href=#781 id=781 data-nosnippet>781</a> </span><span class="kw">pub fn </span>as_raw_fd() {
<a href=#782 id=782 data-nosnippet>782</a> <span class="kw">let </span>poll = Poll::new().unwrap();
<a href=#783 id=783 data-nosnippet>783</a> <span class="macro">assert!</span>(poll.as_raw_fd() &gt; <span class="number">0</span>);
<a href=#784 id=784 data-nosnippet>784</a> }
<a href=#785 id=785 data-nosnippet>785</a>}
</code></pre></div></section></main></body></html>
+148
View File
@@ -0,0 +1,148 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../static.files/src-script-813739b1.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Module with system specific types.
<a href=#2 id=2 data-nosnippet>2</a>//!
<a href=#3 id=3 data-nosnippet>3</a>//! Required types:
<a href=#4 id=4 data-nosnippet>4</a>//!
<a href=#5 id=5 data-nosnippet>5</a>//! * `Event`: a type alias for the system specific event, e.g. `kevent` or
<a href=#6 id=6 data-nosnippet>6</a>//! `epoll_event`.
<a href=#7 id=7 data-nosnippet>7</a>//! * `event`: a module with various helper functions for `Event`, see
<a href=#8 id=8 data-nosnippet>8</a>//! [`crate::event::Event`] for the required functions.
<a href=#9 id=9 data-nosnippet>9</a>//! * `Events`: collection of `Event`s, see [`crate::Events`].
<a href=#10 id=10 data-nosnippet>10</a>//! * `IoSourceState`: state for the `IoSource` type.
<a href=#11 id=11 data-nosnippet>11</a>//! * `Selector`: selector used to register event sources and poll for events,
<a href=#12 id=12 data-nosnippet>12</a>//! see [`crate::Poll`] and [`crate::Registry`] for required methods.
<a href=#13 id=13 data-nosnippet>13</a>//! * `tcp` and `udp` modules: see the [`crate::net`] module.
<a href=#14 id=14 data-nosnippet>14</a>//! * `Waker`: see [`crate::Waker`].
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a></span><span class="macro">cfg_os_poll!</span> {
<a href=#17 id=17 data-nosnippet>17</a> <span class="macro">macro_rules!</span> debug_detail {
<a href=#18 id=18 data-nosnippet>18</a> (
<a href=#19 id=19 data-nosnippet>19</a> <span class="macro-nonterminal">$type</span>: ident (<span class="macro-nonterminal">$event_type</span>: ty), <span class="macro-nonterminal">$test</span>: path,
<a href=#20 id=20 data-nosnippet>20</a> $($(<span class="attr">#[<span class="macro-nonterminal">$target</span>: meta]</span>)* <span class="macro-nonterminal">$libc</span>: ident :: <span class="macro-nonterminal">$flag</span>: ident),+ $(,)*
<a href=#21 id=21 data-nosnippet>21</a> ) =&gt; {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">struct </span><span class="macro-nonterminal">$type</span>(<span class="macro-nonterminal">$event_type</span>);
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">impl </span>fmt::Debug <span class="kw">for </span><span class="macro-nonterminal">$type </span>{
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; fmt::Result {
<a href=#26 id=26 data-nosnippet>26</a> <span class="kw">let </span><span class="kw-2">mut </span>written_one = <span class="bool-val">false</span>;
<a href=#27 id=27 data-nosnippet>27</a> $(
<a href=#28 id=28 data-nosnippet>28</a> $(<span class="attr">#[<span class="macro-nonterminal">$target</span>]</span>)*
<a href=#29 id=29 data-nosnippet>29</a> <span class="attr">#[allow(clippy::bad_bit_mask)] </span><span class="comment">// Apparently some flags are zero.
<a href=#30 id=30 data-nosnippet>30</a> </span>{
<a href=#31 id=31 data-nosnippet>31</a> <span class="comment">// Windows doesn't use `libc` but the `afd` module.
<a href=#32 id=32 data-nosnippet>32</a> </span><span class="kw">if </span><span class="macro-nonterminal">$test</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="kw-2">&amp;</span><span class="macro-nonterminal">$libc </span>:: <span class="macro-nonterminal">$flag</span>) {
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">if </span>!written_one {
<a href=#34 id=34 data-nosnippet>34</a> <span class="macro">write!</span>(f, <span class="string">"{}"</span>, <span class="macro">stringify!</span>(<span class="macro-nonterminal">$flag</span>))<span class="question-mark">?</span>;
<a href=#35 id=35 data-nosnippet>35</a> written_one = <span class="bool-val">true</span>;
<a href=#36 id=36 data-nosnippet>36</a> } <span class="kw">else </span>{
<a href=#37 id=37 data-nosnippet>37</a> <span class="macro">write!</span>(f, <span class="string">"|{}"</span>, <span class="macro">stringify!</span>(<span class="macro-nonterminal">$flag</span>))<span class="question-mark">?</span>;
<a href=#38 id=38 data-nosnippet>38</a> }
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a> }
<a href=#41 id=41 data-nosnippet>41</a> )+
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if </span>!written_one {
<a href=#43 id=43 data-nosnippet>43</a> <span class="macro">write!</span>(f, <span class="string">"(empty)"</span>)
<a href=#44 id=44 data-nosnippet>44</a> } <span class="kw">else </span>{
<a href=#45 id=45 data-nosnippet>45</a> <span class="prelude-val">Ok</span>(())
<a href=#46 id=46 data-nosnippet>46</a> }
<a href=#47 id=47 data-nosnippet>47</a> }
<a href=#48 id=48 data-nosnippet>48</a> }
<a href=#49 id=49 data-nosnippet>49</a> };
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>}
<a href=#52 id=52 data-nosnippet>52</a>
<a href=#53 id=53 data-nosnippet>53</a><span class="attr">#[cfg(any(unix, target_os = <span class="string">"hermit"</span>))]
<a href=#54 id=54 data-nosnippet>54</a></span><span class="macro">cfg_os_poll!</span> {
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">mod </span>unix;
<a href=#56 id=56 data-nosnippet>56</a> <span class="attr">#[allow(unused_imports)]
<a href=#57 id=57 data-nosnippet>57</a> </span><span class="kw">pub use </span><span class="self">self</span>::unix::<span class="kw-2">*</span>;
<a href=#58 id=58 data-nosnippet>58</a>}
<a href=#59 id=59 data-nosnippet>59</a>
<a href=#60 id=60 data-nosnippet>60</a><span class="attr">#[cfg(windows)]
<a href=#61 id=61 data-nosnippet>61</a></span><span class="macro">cfg_os_poll!</span> {
<a href=#62 id=62 data-nosnippet>62</a> <span class="kw">mod </span>windows;
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">pub use </span><span class="self">self</span>::windows::<span class="kw-2">*</span>;
<a href=#64 id=64 data-nosnippet>64</a>}
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a><span class="attr">#[cfg(target_os = <span class="string">"wasi"</span>)]
<a href=#67 id=67 data-nosnippet>67</a></span><span class="macro">cfg_os_poll!</span> {
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">mod </span>wasi;
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::wasi::<span class="kw-2">*</span>;
<a href=#70 id=70 data-nosnippet>70</a>}
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a><span class="macro">cfg_not_os_poll!</span> {
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">mod </span>shell;
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::shell::<span class="kw-2">*</span>;
<a href=#75 id=75 data-nosnippet>75</a>
<a href=#76 id=76 data-nosnippet>76</a> <span class="attr">#[cfg(unix)]
<a href=#77 id=77 data-nosnippet>77</a> </span><span class="macro">cfg_any_os_ext!</span> {
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">mod </span>unix;
<a href=#79 id=79 data-nosnippet>79</a> <span class="attr">#[cfg(feature = <span class="string">"os-ext"</span>)]
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">pub use </span><span class="self">self</span>::unix::SourceFd;
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a>}
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a><span class="doccomment">/// Define the `listen` backlog parameters as in the standard library. This
<a href=#85 id=85 data-nosnippet>85</a>/// helps avoid hardcoded unsynchronized values and allows better control of
<a href=#86 id=86 data-nosnippet>86</a>/// default values depending on the target.
<a href=#87 id=87 data-nosnippet>87</a>///
<a href=#88 id=88 data-nosnippet>88</a>/// Selecting a “valid” default value can be tricky due to:
<a href=#89 id=89 data-nosnippet>89</a>///
<a href=#90 id=90 data-nosnippet>90</a>/// - It often serves only as a hint and may be rounded, trimmed, or ignored by
<a href=#91 id=91 data-nosnippet>91</a>/// the OS.
<a href=#92 id=92 data-nosnippet>92</a>///
<a href=#93 id=93 data-nosnippet>93</a>/// - It is sometimes provided as a "magic" value, for example, -1. This
<a href=#94 id=94 data-nosnippet>94</a>/// value is undocumented and not standard, but it is often used to represent
<a href=#95 id=95 data-nosnippet>95</a>/// the largest possible backlog size. This happens due to signed/unsigned
<a href=#96 id=96 data-nosnippet>96</a>/// conversion and rounding to the upper bound performed by the OS.
<a href=#97 id=97 data-nosnippet>97</a>///
<a href=#98 id=98 data-nosnippet>98</a>/// - Default values vary depending on the OS and its version. Common defaults
<a href=#99 id=99 data-nosnippet>99</a>/// include: -1, 128, 1024, and 4096.
<a href=#100 id=100 data-nosnippet>100</a>///
<a href=#101 id=101 data-nosnippet>101</a></span><span class="comment">// Here is the original code from the standard library
<a href=#102 id=102 data-nosnippet>102</a>// https://github.com/rust-lang/rust/blob/4f808ba6bf9f1c8dde30d009e73386d984491587/library/std/src/os/unix/net/listener.rs#L72
<a href=#103 id=103 data-nosnippet>103</a>//
<a href=#104 id=104 data-nosnippet>104</a></span><span class="attr">#[allow(dead_code)]
<a href=#105 id=105 data-nosnippet>105</a>#[cfg(any(
<a href=#106 id=106 data-nosnippet>106</a> target_os = <span class="string">"windows"</span>,
<a href=#107 id=107 data-nosnippet>107</a> target_os = <span class="string">"redox"</span>,
<a href=#108 id=108 data-nosnippet>108</a> target_os = <span class="string">"espidf"</span>,
<a href=#109 id=109 data-nosnippet>109</a> target_os = <span class="string">"horizon"
<a href=#110 id=110 data-nosnippet>110</a></span>))]
<a href=#111 id=111 data-nosnippet>111</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>LISTEN_BACKLOG_SIZE: i32 = <span class="number">128</span>;
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a><span class="doccomment">/// This is a special case for some target(s) supported by `mio`. This value
<a href=#114 id=114 data-nosnippet>114</a>/// is needed because `libc::SOMAXCON` (used as a fallback for unknown targets)
<a href=#115 id=115 data-nosnippet>115</a>/// is not implemented for them. Feel free to update this if the `libc` crate
<a href=#116 id=116 data-nosnippet>116</a>/// changes.
<a href=#117 id=117 data-nosnippet>117</a></span><span class="attr">#[allow(dead_code)]
<a href=#118 id=118 data-nosnippet>118</a>#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#119 id=119 data-nosnippet>119</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>LISTEN_BACKLOG_SIZE: i32 = <span class="number">1024</span>;
<a href=#120 id=120 data-nosnippet>120</a>
<a href=#121 id=121 data-nosnippet>121</a><span class="attr">#[allow(dead_code)]
<a href=#122 id=122 data-nosnippet>122</a>#[cfg(any(
<a href=#123 id=123 data-nosnippet>123</a> <span class="comment">// Silently capped to `/proc/sys/net/core/somaxconn`.
<a href=#124 id=124 data-nosnippet>124</a> </span>target_os = <span class="string">"linux"</span>,
<a href=#125 id=125 data-nosnippet>125</a> <span class="comment">// Silently capped to `kern.ipc.soacceptqueue`.
<a href=#126 id=126 data-nosnippet>126</a> </span>target_os = <span class="string">"freebsd"</span>,
<a href=#127 id=127 data-nosnippet>127</a> <span class="comment">// Silently capped to `kern.somaxconn sysctl`.
<a href=#128 id=128 data-nosnippet>128</a> </span>target_os = <span class="string">"openbsd"</span>,
<a href=#129 id=129 data-nosnippet>129</a> <span class="comment">// Silently capped to the default 128.
<a href=#130 id=130 data-nosnippet>130</a> </span>target_vendor = <span class="string">"apple"</span>,
<a href=#131 id=131 data-nosnippet>131</a>))]
<a href=#132 id=132 data-nosnippet>132</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>LISTEN_BACKLOG_SIZE: i32 = -<span class="number">1</span>;
<a href=#133 id=133 data-nosnippet>133</a>
<a href=#134 id=134 data-nosnippet>134</a><span class="attr">#[allow(dead_code)]
<a href=#135 id=135 data-nosnippet>135</a>#[cfg(not(any(
<a href=#136 id=136 data-nosnippet>136</a> target_os = <span class="string">"windows"</span>,
<a href=#137 id=137 data-nosnippet>137</a> target_os = <span class="string">"redox"</span>,
<a href=#138 id=138 data-nosnippet>138</a> target_os = <span class="string">"espidf"</span>,
<a href=#139 id=139 data-nosnippet>139</a> target_os = <span class="string">"horizon"</span>,
<a href=#140 id=140 data-nosnippet>140</a> target_os = <span class="string">"linux"</span>,
<a href=#141 id=141 data-nosnippet>141</a> target_os = <span class="string">"freebsd"</span>,
<a href=#142 id=142 data-nosnippet>142</a> target_os = <span class="string">"openbsd"</span>,
<a href=#143 id=143 data-nosnippet>143</a> target_os = <span class="string">"wasi"</span>,
<a href=#144 id=144 data-nosnippet>144</a> target_os = <span class="string">"hermit"</span>,
<a href=#145 id=145 data-nosnippet>145</a> target_vendor = <span class="string">"apple"</span>,
<a href=#146 id=146 data-nosnippet>146</a>)))]
<a href=#147 id=147 data-nosnippet>147</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>LISTEN_BACKLOG_SIZE: i32 = libc::SOMAXCONN;
</code></pre></div></section></main></body></html>
+168
View File
@@ -0,0 +1,168 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">/// Helper macro to execute a system call that returns an `io::Result`.
<a href=#2 id=2 data-nosnippet>2</a></span><span class="comment">//
<a href=#3 id=3 data-nosnippet>3</a>// Macro must be defined before any modules that uses them.
<a href=#4 id=4 data-nosnippet>4</a></span><span class="attr">#[allow(unused_macros)]
<a href=#5 id=5 data-nosnippet>5</a></span><span class="macro">macro_rules!</span> syscall {
<a href=#6 id=6 data-nosnippet>6</a> (<span class="macro-nonterminal">$fn</span>: ident ( $(<span class="macro-nonterminal">$arg</span>: expr),* $(,)* ) ) =&gt; {{
<a href=#7 id=7 data-nosnippet>7</a> <span class="attr">#[allow(unused_unsafe)]
<a href=#8 id=8 data-nosnippet>8</a> </span><span class="kw">let </span>res = <span class="kw">unsafe </span>{ libc::<span class="macro-nonterminal">$fn</span>($(<span class="macro-nonterminal">$arg</span>, )<span class="kw-2">*</span>) };
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">if </span>res &lt; <span class="number">0 </span>{
<a href=#10 id=10 data-nosnippet>10</a> <span class="prelude-val">Err</span>(std::io::Error::last_os_error())
<a href=#11 id=11 data-nosnippet>11</a> } <span class="kw">else </span>{
<a href=#12 id=12 data-nosnippet>12</a> <span class="prelude-val">Ok</span>(res)
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a> }};
<a href=#15 id=15 data-nosnippet>15</a>}
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="macro">cfg_os_poll!</span> {
<a href=#18 id=18 data-nosnippet>18</a> <span class="attr">#[cfg_attr(all(
<a href=#19 id=19 data-nosnippet>19</a> not(mio_unsupported_force_poll_poll),
<a href=#20 id=20 data-nosnippet>20</a> any(
<a href=#21 id=21 data-nosnippet>21</a> target_os = <span class="string">"android"</span>,
<a href=#22 id=22 data-nosnippet>22</a> target_os = <span class="string">"illumos"</span>,
<a href=#23 id=23 data-nosnippet>23</a> target_os = <span class="string">"linux"</span>,
<a href=#24 id=24 data-nosnippet>24</a> target_os = <span class="string">"redox"</span>,
<a href=#25 id=25 data-nosnippet>25</a> )
<a href=#26 id=26 data-nosnippet>26</a> ), path = <span class="string">"selector/epoll.rs"</span>)]
<a href=#27 id=27 data-nosnippet>27</a> #[cfg_attr(all(
<a href=#28 id=28 data-nosnippet>28</a> not(mio_unsupported_force_poll_poll),
<a href=#29 id=29 data-nosnippet>29</a> any(
<a href=#30 id=30 data-nosnippet>30</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#31 id=31 data-nosnippet>31</a> target_os = <span class="string">"freebsd"</span>,
<a href=#32 id=32 data-nosnippet>32</a> target_os = <span class="string">"ios"</span>,
<a href=#33 id=33 data-nosnippet>33</a> target_os = <span class="string">"macos"</span>,
<a href=#34 id=34 data-nosnippet>34</a> target_os = <span class="string">"netbsd"</span>,
<a href=#35 id=35 data-nosnippet>35</a> target_os = <span class="string">"openbsd"</span>,
<a href=#36 id=36 data-nosnippet>36</a> target_os = <span class="string">"tvos"</span>,
<a href=#37 id=37 data-nosnippet>37</a> target_os = <span class="string">"visionos"</span>,
<a href=#38 id=38 data-nosnippet>38</a> target_os = <span class="string">"watchos"</span>,
<a href=#39 id=39 data-nosnippet>39</a> )
<a href=#40 id=40 data-nosnippet>40</a> ), path = <span class="string">"selector/kqueue.rs"</span>)]
<a href=#41 id=41 data-nosnippet>41</a> #[cfg_attr(any(
<a href=#42 id=42 data-nosnippet>42</a> mio_unsupported_force_poll_poll,
<a href=#43 id=43 data-nosnippet>43</a> target_os = <span class="string">"aix"</span>,
<a href=#44 id=44 data-nosnippet>44</a> target_os = <span class="string">"espidf"</span>,
<a href=#45 id=45 data-nosnippet>45</a> target_os = <span class="string">"fuchsia"</span>,
<a href=#46 id=46 data-nosnippet>46</a> target_os = <span class="string">"haiku"</span>,
<a href=#47 id=47 data-nosnippet>47</a> target_os = <span class="string">"hermit"</span>,
<a href=#48 id=48 data-nosnippet>48</a> target_os = <span class="string">"hurd"</span>,
<a href=#49 id=49 data-nosnippet>49</a> target_os = <span class="string">"nto"</span>,
<a href=#50 id=50 data-nosnippet>50</a> target_os = <span class="string">"solaris"</span>,
<a href=#51 id=51 data-nosnippet>51</a> target_os = <span class="string">"vita"</span>,
<a href=#52 id=52 data-nosnippet>52</a> target_os = <span class="string">"cygwin"</span>,
<a href=#53 id=53 data-nosnippet>53</a> ), path = <span class="string">"selector/poll.rs"</span>)]
<a href=#54 id=54 data-nosnippet>54</a> </span><span class="kw">mod </span>selector;
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::selector::<span class="kw-2">*</span>;
<a href=#56 id=56 data-nosnippet>56</a>
<a href=#57 id=57 data-nosnippet>57</a> <span class="attr">#[cfg_attr(all(
<a href=#58 id=58 data-nosnippet>58</a> not(mio_unsupported_force_waker_pipe),
<a href=#59 id=59 data-nosnippet>59</a> any(
<a href=#60 id=60 data-nosnippet>60</a> target_os = <span class="string">"android"</span>,
<a href=#61 id=61 data-nosnippet>61</a> target_os = <span class="string">"espidf"</span>,
<a href=#62 id=62 data-nosnippet>62</a> target_os = <span class="string">"fuchsia"</span>,
<a href=#63 id=63 data-nosnippet>63</a> target_os = <span class="string">"hermit"</span>,
<a href=#64 id=64 data-nosnippet>64</a> target_os = <span class="string">"illumos"</span>,
<a href=#65 id=65 data-nosnippet>65</a> target_os = <span class="string">"linux"</span>,
<a href=#66 id=66 data-nosnippet>66</a> )
<a href=#67 id=67 data-nosnippet>67</a> ), path = <span class="string">"waker/eventfd.rs"</span>)]
<a href=#68 id=68 data-nosnippet>68</a> #[cfg_attr(all(
<a href=#69 id=69 data-nosnippet>69</a> not(mio_unsupported_force_waker_pipe),
<a href=#70 id=70 data-nosnippet>70</a> not(mio_unsupported_force_poll_poll), <span class="comment">// `kqueue(2)` based waker doesn't work with `poll(2)`.
<a href=#71 id=71 data-nosnippet>71</a> </span>any(
<a href=#72 id=72 data-nosnippet>72</a> target_os = <span class="string">"freebsd"</span>,
<a href=#73 id=73 data-nosnippet>73</a> target_os = <span class="string">"ios"</span>,
<a href=#74 id=74 data-nosnippet>74</a> target_os = <span class="string">"macos"</span>,
<a href=#75 id=75 data-nosnippet>75</a> target_os = <span class="string">"tvos"</span>,
<a href=#76 id=76 data-nosnippet>76</a> target_os = <span class="string">"visionos"</span>,
<a href=#77 id=77 data-nosnippet>77</a> target_os = <span class="string">"watchos"</span>,
<a href=#78 id=78 data-nosnippet>78</a> )
<a href=#79 id=79 data-nosnippet>79</a> ), path = <span class="string">"waker/kqueue.rs"</span>)]
<a href=#80 id=80 data-nosnippet>80</a> #[cfg_attr(any(
<a href=#81 id=81 data-nosnippet>81</a> <span class="comment">// NOTE: also add to the list for the `pipe` module below.
<a href=#82 id=82 data-nosnippet>82</a> </span>mio_unsupported_force_waker_pipe,
<a href=#83 id=83 data-nosnippet>83</a> all(
<a href=#84 id=84 data-nosnippet>84</a> <span class="comment">// `kqueue(2)` based waker doesn't work with `poll(2)`.
<a href=#85 id=85 data-nosnippet>85</a> </span>mio_unsupported_force_poll_poll,
<a href=#86 id=86 data-nosnippet>86</a> any(
<a href=#87 id=87 data-nosnippet>87</a> target_os = <span class="string">"freebsd"</span>,
<a href=#88 id=88 data-nosnippet>88</a> target_os = <span class="string">"ios"</span>,
<a href=#89 id=89 data-nosnippet>89</a> target_os = <span class="string">"macos"</span>,
<a href=#90 id=90 data-nosnippet>90</a> target_os = <span class="string">"tvos"</span>,
<a href=#91 id=91 data-nosnippet>91</a> target_os = <span class="string">"visionos"</span>,
<a href=#92 id=92 data-nosnippet>92</a> target_os = <span class="string">"watchos"</span>,
<a href=#93 id=93 data-nosnippet>93</a> ),
<a href=#94 id=94 data-nosnippet>94</a> ),
<a href=#95 id=95 data-nosnippet>95</a> target_os = <span class="string">"aix"</span>,
<a href=#96 id=96 data-nosnippet>96</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#97 id=97 data-nosnippet>97</a> target_os = <span class="string">"haiku"</span>,
<a href=#98 id=98 data-nosnippet>98</a> target_os = <span class="string">"hurd"</span>,
<a href=#99 id=99 data-nosnippet>99</a> target_os = <span class="string">"netbsd"</span>,
<a href=#100 id=100 data-nosnippet>100</a> target_os = <span class="string">"nto"</span>,
<a href=#101 id=101 data-nosnippet>101</a> target_os = <span class="string">"openbsd"</span>,
<a href=#102 id=102 data-nosnippet>102</a> target_os = <span class="string">"redox"</span>,
<a href=#103 id=103 data-nosnippet>103</a> target_os = <span class="string">"solaris"</span>,
<a href=#104 id=104 data-nosnippet>104</a> target_os = <span class="string">"vita"</span>,
<a href=#105 id=105 data-nosnippet>105</a> target_os = <span class="string">"cygwin"</span>,
<a href=#106 id=106 data-nosnippet>106</a> ), path = <span class="string">"waker/pipe.rs"</span>)]
<a href=#107 id=107 data-nosnippet>107</a> </span><span class="kw">mod </span>waker;
<a href=#108 id=108 data-nosnippet>108</a> <span class="comment">// NOTE: the `Waker` type is expected in the selector module as the
<a href=#109 id=109 data-nosnippet>109</a> // `poll(2)` implementation needs to do some special stuff.
<a href=#110 id=110 data-nosnippet>110</a>
<a href=#111 id=111 data-nosnippet>111</a> </span><span class="attr">#[cfg(feature = <span class="string">"os-ext"</span>)]
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="kw">mod </span>sourcefd;
<a href=#113 id=113 data-nosnippet>113</a> <span class="attr">#[cfg(feature = <span class="string">"os-ext"</span>)]
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">pub use </span><span class="self">self</span>::sourcefd::SourceFd;
<a href=#115 id=115 data-nosnippet>115</a>
<a href=#116 id=116 data-nosnippet>116</a> <span class="macro">cfg_net!</span> {
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">mod </span>net;
<a href=#118 id=118 data-nosnippet>118</a>
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>tcp;
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>udp;
<a href=#121 id=121 data-nosnippet>121</a> <span class="attr">#[cfg(not(target_os = <span class="string">"hermit"</span>))]
<a href=#122 id=122 data-nosnippet>122</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>uds;
<a href=#123 id=123 data-nosnippet>123</a> }
<a href=#124 id=124 data-nosnippet>124</a>
<a href=#125 id=125 data-nosnippet>125</a> <span class="attr">#[cfg(all(
<a href=#126 id=126 data-nosnippet>126</a> any(
<a href=#127 id=127 data-nosnippet>127</a> <span class="comment">// For the public `pipe` module, must match `cfg_os_ext` macro.
<a href=#128 id=128 data-nosnippet>128</a> </span>feature = <span class="string">"os-ext"</span>,
<a href=#129 id=129 data-nosnippet>129</a> <span class="comment">// For the `Waker` type based on a pipe.
<a href=#130 id=130 data-nosnippet>130</a> </span>mio_unsupported_force_waker_pipe,
<a href=#131 id=131 data-nosnippet>131</a> all(
<a href=#132 id=132 data-nosnippet>132</a> <span class="comment">// `kqueue(2)` based waker doesn't work with `poll(2)`.
<a href=#133 id=133 data-nosnippet>133</a> </span>mio_unsupported_force_poll_poll,
<a href=#134 id=134 data-nosnippet>134</a> any(
<a href=#135 id=135 data-nosnippet>135</a> target_os = <span class="string">"freebsd"</span>,
<a href=#136 id=136 data-nosnippet>136</a> target_os = <span class="string">"ios"</span>,
<a href=#137 id=137 data-nosnippet>137</a> target_os = <span class="string">"macos"</span>,
<a href=#138 id=138 data-nosnippet>138</a> target_os = <span class="string">"tvos"</span>,
<a href=#139 id=139 data-nosnippet>139</a> target_os = <span class="string">"visionos"</span>,
<a href=#140 id=140 data-nosnippet>140</a> target_os = <span class="string">"watchos"</span>,
<a href=#141 id=141 data-nosnippet>141</a> ),
<a href=#142 id=142 data-nosnippet>142</a> ),
<a href=#143 id=143 data-nosnippet>143</a> <span class="comment">// NOTE: also add to the list for the `pipe` module below.
<a href=#144 id=144 data-nosnippet>144</a> </span>target_os = <span class="string">"aix"</span>,
<a href=#145 id=145 data-nosnippet>145</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#146 id=146 data-nosnippet>146</a> target_os = <span class="string">"haiku"</span>,
<a href=#147 id=147 data-nosnippet>147</a> target_os = <span class="string">"hurd"</span>,
<a href=#148 id=148 data-nosnippet>148</a> target_os = <span class="string">"netbsd"</span>,
<a href=#149 id=149 data-nosnippet>149</a> target_os = <span class="string">"nto"</span>,
<a href=#150 id=150 data-nosnippet>150</a> target_os = <span class="string">"openbsd"</span>,
<a href=#151 id=151 data-nosnippet>151</a> target_os = <span class="string">"redox"</span>,
<a href=#152 id=152 data-nosnippet>152</a> target_os = <span class="string">"solaris"</span>,
<a href=#153 id=153 data-nosnippet>153</a> target_os = <span class="string">"vita"</span>,
<a href=#154 id=154 data-nosnippet>154</a> target_os = <span class="string">"cygwin"</span>,
<a href=#155 id=155 data-nosnippet>155</a> ),
<a href=#156 id=156 data-nosnippet>156</a> <span class="comment">// Hermit doesn't support pipes.
<a href=#157 id=157 data-nosnippet>157</a> </span>not(target_os = <span class="string">"hermit"</span>),
<a href=#158 id=158 data-nosnippet>158</a> ))]
<a href=#159 id=159 data-nosnippet>159</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>pipe;
<a href=#160 id=160 data-nosnippet>160</a>}
<a href=#161 id=161 data-nosnippet>161</a>
<a href=#162 id=162 data-nosnippet>162</a><span class="macro">cfg_not_os_poll!</span> {
<a href=#163 id=163 data-nosnippet>163</a> <span class="macro">cfg_os_ext!</span> {
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">mod </span>sourcefd;
<a href=#165 id=165 data-nosnippet>165</a> <span class="kw">pub use </span><span class="self">self</span>::sourcefd::SourceFd;
<a href=#166 id=166 data-nosnippet>166</a> }
<a href=#167 id=167 data-nosnippet>167</a>}
</code></pre></div></section></main></body></html>
+217
View File
@@ -0,0 +1,217 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/net.rs`."><title>net.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/</div>net.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::io;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::mem::size_of;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::net::{Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6};
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_ip_socket(addr: SocketAddr, socket_type: libc::c_int) -&gt; io::Result&lt;libc::c_int&gt; {
<a href=#6 id=6 data-nosnippet>6</a> <span class="kw">let </span>domain = <span class="kw">match </span>addr {
<a href=#7 id=7 data-nosnippet>7</a> SocketAddr::V4(..) =&gt; libc::AF_INET,
<a href=#8 id=8 data-nosnippet>8</a> SocketAddr::V6(..) =&gt; libc::AF_INET6,
<a href=#9 id=9 data-nosnippet>9</a> };
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a> new_socket(domain, socket_type)
<a href=#12 id=12 data-nosnippet>12</a>}
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="doccomment">/// Create a new non-blocking socket.
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_socket(domain: libc::c_int, socket_type: libc::c_int) -&gt; io::Result&lt;libc::c_int&gt; {
<a href=#16 id=16 data-nosnippet>16</a> <span class="attr">#[cfg(any(
<a href=#17 id=17 data-nosnippet>17</a> target_os = <span class="string">"android"</span>,
<a href=#18 id=18 data-nosnippet>18</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#19 id=19 data-nosnippet>19</a> target_os = <span class="string">"freebsd"</span>,
<a href=#20 id=20 data-nosnippet>20</a> target_os = <span class="string">"hurd"</span>,
<a href=#21 id=21 data-nosnippet>21</a> target_os = <span class="string">"illumos"</span>,
<a href=#22 id=22 data-nosnippet>22</a> target_os = <span class="string">"linux"</span>,
<a href=#23 id=23 data-nosnippet>23</a> target_os = <span class="string">"netbsd"</span>,
<a href=#24 id=24 data-nosnippet>24</a> target_os = <span class="string">"openbsd"</span>,
<a href=#25 id=25 data-nosnippet>25</a> target_os = <span class="string">"solaris"</span>,
<a href=#26 id=26 data-nosnippet>26</a> target_os = <span class="string">"hermit"</span>,
<a href=#27 id=27 data-nosnippet>27</a> target_os = <span class="string">"cygwin"</span>,
<a href=#28 id=28 data-nosnippet>28</a> ))]
<a href=#29 id=29 data-nosnippet>29</a> </span><span class="kw">let </span>socket_type = socket_type | libc::SOCK_NONBLOCK | libc::SOCK_CLOEXEC;
<a href=#30 id=30 data-nosnippet>30</a> <span class="attr">#[cfg(target_os = <span class="string">"nto"</span>)]
<a href=#31 id=31 data-nosnippet>31</a> </span><span class="kw">let </span>socket_type = socket_type | libc::SOCK_CLOEXEC;
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a> <span class="kw">let </span>socket = <span class="macro">syscall!</span>(socket(domain, socket_type, <span class="number">0</span>))<span class="question-mark">?</span>;
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="comment">// Mimic `libstd` and set `SO_NOSIGPIPE` on apple systems.
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="attr">#[cfg(any(
<a href=#37 id=37 data-nosnippet>37</a> target_os = <span class="string">"ios"</span>,
<a href=#38 id=38 data-nosnippet>38</a> target_os = <span class="string">"macos"</span>,
<a href=#39 id=39 data-nosnippet>39</a> target_os = <span class="string">"tvos"</span>,
<a href=#40 id=40 data-nosnippet>40</a> target_os = <span class="string">"visionos"</span>,
<a href=#41 id=41 data-nosnippet>41</a> target_os = <span class="string">"watchos"</span>,
<a href=#42 id=42 data-nosnippet>42</a> ))]
<a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">if let </span><span class="prelude-val">Err</span>(err) = <span class="macro">syscall!</span>(setsockopt(
<a href=#44 id=44 data-nosnippet>44</a> socket,
<a href=#45 id=45 data-nosnippet>45</a> libc::SOL_SOCKET,
<a href=#46 id=46 data-nosnippet>46</a> libc::SO_NOSIGPIPE,
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw-2">&amp;</span><span class="number">1 </span><span class="kw">as </span><span class="kw-2">*const </span>libc::c_int <span class="kw">as </span><span class="kw-2">*const </span>libc::c_void,
<a href=#48 id=48 data-nosnippet>48</a> size_of::&lt;libc::c_int&gt;() <span class="kw">as </span>libc::socklen_t
<a href=#49 id=49 data-nosnippet>49</a> )) {
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let _ </span>= <span class="macro">syscall!</span>(close(socket));
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">return </span><span class="prelude-val">Err</span>(err);
<a href=#52 id=52 data-nosnippet>52</a> }
<a href=#53 id=53 data-nosnippet>53</a>
<a href=#54 id=54 data-nosnippet>54</a> <span class="comment">// Darwin (and others) doesn't have SOCK_NONBLOCK or SOCK_CLOEXEC.
<a href=#55 id=55 data-nosnippet>55</a> </span><span class="attr">#[cfg(any(
<a href=#56 id=56 data-nosnippet>56</a> target_os = <span class="string">"aix"</span>,
<a href=#57 id=57 data-nosnippet>57</a> target_os = <span class="string">"ios"</span>,
<a href=#58 id=58 data-nosnippet>58</a> target_os = <span class="string">"macos"</span>,
<a href=#59 id=59 data-nosnippet>59</a> target_os = <span class="string">"tvos"</span>,
<a href=#60 id=60 data-nosnippet>60</a> target_os = <span class="string">"visionos"</span>,
<a href=#61 id=61 data-nosnippet>61</a> target_os = <span class="string">"watchos"</span>,
<a href=#62 id=62 data-nosnippet>62</a> target_os = <span class="string">"espidf"</span>,
<a href=#63 id=63 data-nosnippet>63</a> target_os = <span class="string">"vita"</span>,
<a href=#64 id=64 data-nosnippet>64</a> target_os = <span class="string">"nto"</span>,
<a href=#65 id=65 data-nosnippet>65</a> ))]
<a href=#66 id=66 data-nosnippet>66</a> </span>{
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">if let </span><span class="prelude-val">Err</span>(err) = <span class="macro">syscall!</span>(fcntl(socket, libc::F_SETFL, libc::O_NONBLOCK)) {
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let _ </span>= <span class="macro">syscall!</span>(close(socket));
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">return </span><span class="prelude-val">Err</span>(err);
<a href=#70 id=70 data-nosnippet>70</a> }
<a href=#71 id=71 data-nosnippet>71</a> <span class="attr">#[cfg(not(any(target_os = <span class="string">"espidf"</span>, target_os = <span class="string">"vita"</span>, target_os = <span class="string">"nto"</span>)))]
<a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">if let </span><span class="prelude-val">Err</span>(err) = <span class="macro">syscall!</span>(fcntl(socket, libc::F_SETFD, libc::FD_CLOEXEC)) {
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let _ </span>= <span class="macro">syscall!</span>(close(socket));
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">return </span><span class="prelude-val">Err</span>(err);
<a href=#75 id=75 data-nosnippet>75</a> }
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a> <span class="prelude-val">Ok</span>(socket)
<a href=#79 id=79 data-nosnippet>79</a>}
<a href=#80 id=80 data-nosnippet>80</a>
<a href=#81 id=81 data-nosnippet>81</a><span class="doccomment">/// A type with the same memory layout as `libc::sockaddr`. Used in converting Rust level
<a href=#82 id=82 data-nosnippet>82</a>/// SocketAddr* types into their system representation. The benefit of this specific
<a href=#83 id=83 data-nosnippet>83</a>/// type over using `libc::sockaddr_storage` is that this type is exactly as large as it
<a href=#84 id=84 data-nosnippet>84</a>/// needs to be and not a lot larger. And it can be initialized cleaner from Rust.
<a href=#85 id=85 data-nosnippet>85</a></span><span class="attr">#[repr(C)]
<a href=#86 id=86 data-nosnippet>86</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">union </span>SocketAddrCRepr {
<a href=#87 id=87 data-nosnippet>87</a> v4: libc::sockaddr_in,
<a href=#88 id=88 data-nosnippet>88</a> v6: libc::sockaddr_in6,
<a href=#89 id=89 data-nosnippet>89</a>}
<a href=#90 id=90 data-nosnippet>90</a>
<a href=#91 id=91 data-nosnippet>91</a><span class="kw">impl </span>SocketAddrCRepr {
<a href=#92 id=92 data-nosnippet>92</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_ptr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">*const </span>libc::sockaddr {
<a href=#93 id=93 data-nosnippet>93</a> <span class="self">self </span><span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span><span class="kw-2">*const </span>libc::sockaddr
<a href=#94 id=94 data-nosnippet>94</a> }
<a href=#95 id=95 data-nosnippet>95</a>}
<a href=#96 id=96 data-nosnippet>96</a>
<a href=#97 id=97 data-nosnippet>97</a><span class="doccomment">/// Converts a Rust `SocketAddr` into the system representation.
<a href=#98 id=98 data-nosnippet>98</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>socket_addr(addr: <span class="kw-2">&amp;</span>SocketAddr) -&gt; (SocketAddrCRepr, libc::socklen_t) {
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">match </span>addr {
<a href=#100 id=100 data-nosnippet>100</a> SocketAddr::V4(<span class="kw-2">ref </span>addr) =&gt; {
<a href=#101 id=101 data-nosnippet>101</a> <span class="comment">// `s_addr` is stored as BE on all machine and the array is in BE order.
<a href=#102 id=102 data-nosnippet>102</a> // So the native endian conversion method is used so that it's never swapped.
<a href=#103 id=103 data-nosnippet>103</a> </span><span class="kw">let </span>sin_addr = libc::in_addr {
<a href=#104 id=104 data-nosnippet>104</a> s_addr: u32::from_ne_bytes(addr.ip().octets()),
<a href=#105 id=105 data-nosnippet>105</a> };
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">let </span>sockaddr_in = libc::sockaddr_in {
<a href=#108 id=108 data-nosnippet>108</a> sin_family: libc::AF_INET <span class="kw">as </span>libc::sa_family_t,
<a href=#109 id=109 data-nosnippet>109</a> sin_port: addr.port().to_be(),
<a href=#110 id=110 data-nosnippet>110</a> sin_addr,
<a href=#111 id=111 data-nosnippet>111</a> <span class="attr">#[cfg(not(any(target_os = <span class="string">"haiku"</span>, target_os = <span class="string">"vita"</span>)))]
<a href=#112 id=112 data-nosnippet>112</a> </span>sin_zero: [<span class="number">0</span>; <span class="number">8</span>],
<a href=#113 id=113 data-nosnippet>113</a> <span class="attr">#[cfg(target_os = <span class="string">"haiku"</span>)]
<a href=#114 id=114 data-nosnippet>114</a> </span>sin_zero: [<span class="number">0</span>; <span class="number">24</span>],
<a href=#115 id=115 data-nosnippet>115</a> <span class="attr">#[cfg(target_os = <span class="string">"vita"</span>)]
<a href=#116 id=116 data-nosnippet>116</a> </span>sin_zero: [<span class="number">0</span>; <span class="number">6</span>],
<a href=#117 id=117 data-nosnippet>117</a> <span class="attr">#[cfg(any(
<a href=#118 id=118 data-nosnippet>118</a> target_os = <span class="string">"aix"</span>,
<a href=#119 id=119 data-nosnippet>119</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#120 id=120 data-nosnippet>120</a> target_os = <span class="string">"freebsd"</span>,
<a href=#121 id=121 data-nosnippet>121</a> target_os = <span class="string">"haiku"</span>,
<a href=#122 id=122 data-nosnippet>122</a> target_os = <span class="string">"hurd"</span>,
<a href=#123 id=123 data-nosnippet>123</a> target_os = <span class="string">"ios"</span>,
<a href=#124 id=124 data-nosnippet>124</a> target_os = <span class="string">"macos"</span>,
<a href=#125 id=125 data-nosnippet>125</a> target_os = <span class="string">"netbsd"</span>,
<a href=#126 id=126 data-nosnippet>126</a> target_os = <span class="string">"openbsd"</span>,
<a href=#127 id=127 data-nosnippet>127</a> target_os = <span class="string">"tvos"</span>,
<a href=#128 id=128 data-nosnippet>128</a> target_os = <span class="string">"visionos"</span>,
<a href=#129 id=129 data-nosnippet>129</a> target_os = <span class="string">"watchos"</span>,
<a href=#130 id=130 data-nosnippet>130</a> target_os = <span class="string">"espidf"</span>,
<a href=#131 id=131 data-nosnippet>131</a> target_os = <span class="string">"vita"</span>,
<a href=#132 id=132 data-nosnippet>132</a> target_os = <span class="string">"hermit"</span>,
<a href=#133 id=133 data-nosnippet>133</a> target_os = <span class="string">"nto"</span>,
<a href=#134 id=134 data-nosnippet>134</a> ))]
<a href=#135 id=135 data-nosnippet>135</a> </span>sin_len: <span class="number">0</span>,
<a href=#136 id=136 data-nosnippet>136</a> <span class="attr">#[cfg(target_os = <span class="string">"vita"</span>)]
<a href=#137 id=137 data-nosnippet>137</a> </span>sin_vport: addr.port().to_be(),
<a href=#138 id=138 data-nosnippet>138</a> };
<a href=#139 id=139 data-nosnippet>139</a>
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">let </span>sockaddr = SocketAddrCRepr { v4: sockaddr_in };
<a href=#141 id=141 data-nosnippet>141</a> <span class="kw">let </span>socklen = size_of::&lt;libc::sockaddr_in&gt;() <span class="kw">as </span>libc::socklen_t;
<a href=#142 id=142 data-nosnippet>142</a> (sockaddr, socklen)
<a href=#143 id=143 data-nosnippet>143</a> }
<a href=#144 id=144 data-nosnippet>144</a> SocketAddr::V6(<span class="kw-2">ref </span>addr) =&gt; {
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span>sockaddr_in6 = libc::sockaddr_in6 {
<a href=#146 id=146 data-nosnippet>146</a> sin6_family: libc::AF_INET6 <span class="kw">as </span>libc::sa_family_t,
<a href=#147 id=147 data-nosnippet>147</a> sin6_port: addr.port().to_be(),
<a href=#148 id=148 data-nosnippet>148</a> sin6_addr: libc::in6_addr {
<a href=#149 id=149 data-nosnippet>149</a> s6_addr: addr.ip().octets(),
<a href=#150 id=150 data-nosnippet>150</a> },
<a href=#151 id=151 data-nosnippet>151</a> sin6_flowinfo: addr.flowinfo(),
<a href=#152 id=152 data-nosnippet>152</a> sin6_scope_id: addr.scope_id(),
<a href=#153 id=153 data-nosnippet>153</a> <span class="attr">#[cfg(any(
<a href=#154 id=154 data-nosnippet>154</a> target_os = <span class="string">"aix"</span>,
<a href=#155 id=155 data-nosnippet>155</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#156 id=156 data-nosnippet>156</a> target_os = <span class="string">"freebsd"</span>,
<a href=#157 id=157 data-nosnippet>157</a> target_os = <span class="string">"haiku"</span>,
<a href=#158 id=158 data-nosnippet>158</a> target_os = <span class="string">"hurd"</span>,
<a href=#159 id=159 data-nosnippet>159</a> target_os = <span class="string">"ios"</span>,
<a href=#160 id=160 data-nosnippet>160</a> target_os = <span class="string">"macos"</span>,
<a href=#161 id=161 data-nosnippet>161</a> target_os = <span class="string">"netbsd"</span>,
<a href=#162 id=162 data-nosnippet>162</a> target_os = <span class="string">"openbsd"</span>,
<a href=#163 id=163 data-nosnippet>163</a> target_os = <span class="string">"tvos"</span>,
<a href=#164 id=164 data-nosnippet>164</a> target_os = <span class="string">"visionos"</span>,
<a href=#165 id=165 data-nosnippet>165</a> target_os = <span class="string">"watchos"</span>,
<a href=#166 id=166 data-nosnippet>166</a> target_os = <span class="string">"espidf"</span>,
<a href=#167 id=167 data-nosnippet>167</a> target_os = <span class="string">"vita"</span>,
<a href=#168 id=168 data-nosnippet>168</a> target_os = <span class="string">"nto"</span>,
<a href=#169 id=169 data-nosnippet>169</a> target_os = <span class="string">"hermit"</span>,
<a href=#170 id=170 data-nosnippet>170</a> ))]
<a href=#171 id=171 data-nosnippet>171</a> </span>sin6_len: <span class="number">0</span>,
<a href=#172 id=172 data-nosnippet>172</a> <span class="attr">#[cfg(target_os = <span class="string">"vita"</span>)]
<a href=#173 id=173 data-nosnippet>173</a> </span>sin6_vport: addr.port().to_be(),
<a href=#174 id=174 data-nosnippet>174</a> <span class="attr">#[cfg(any(target_os = <span class="string">"illumos"</span>, target_os = <span class="string">"solaris"</span>))]
<a href=#175 id=175 data-nosnippet>175</a> </span>__sin6_src_id: <span class="number">0</span>,
<a href=#176 id=176 data-nosnippet>176</a> };
<a href=#177 id=177 data-nosnippet>177</a>
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">let </span>sockaddr = SocketAddrCRepr { v6: sockaddr_in6 };
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">let </span>socklen = size_of::&lt;libc::sockaddr_in6&gt;() <span class="kw">as </span>libc::socklen_t;
<a href=#180 id=180 data-nosnippet>180</a> (sockaddr, socklen)
<a href=#181 id=181 data-nosnippet>181</a> }
<a href=#182 id=182 data-nosnippet>182</a> }
<a href=#183 id=183 data-nosnippet>183</a>}
<a href=#184 id=184 data-nosnippet>184</a>
<a href=#185 id=185 data-nosnippet>185</a><span class="doccomment">/// Converts a `libc::sockaddr` compatible struct into a native Rust `SocketAddr`.
<a href=#186 id=186 data-nosnippet>186</a>///
<a href=#187 id=187 data-nosnippet>187</a>/// # Safety
<a href=#188 id=188 data-nosnippet>188</a>///
<a href=#189 id=189 data-nosnippet>189</a>/// `storage` must have the `ss_family` field correctly initialized.
<a href=#190 id=190 data-nosnippet>190</a>/// `storage` must be initialised to a `sockaddr_in` or `sockaddr_in6`.
<a href=#191 id=191 data-nosnippet>191</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">unsafe fn </span>to_socket_addr(
<a href=#192 id=192 data-nosnippet>192</a> storage: <span class="kw-2">*const </span>libc::sockaddr_storage,
<a href=#193 id=193 data-nosnippet>193</a>) -&gt; io::Result&lt;SocketAddr&gt; {
<a href=#194 id=194 data-nosnippet>194</a> <span class="kw">match </span>(<span class="kw-2">*</span>storage).ss_family <span class="kw">as </span>libc::c_int {
<a href=#195 id=195 data-nosnippet>195</a> libc::AF_INET =&gt; {
<a href=#196 id=196 data-nosnippet>196</a> <span class="comment">// Safety: if the ss_family field is AF_INET then storage must be a sockaddr_in.
<a href=#197 id=197 data-nosnippet>197</a> </span><span class="kw">let </span>addr: <span class="kw-2">&amp;</span>libc::sockaddr_in = <span class="kw-2">&amp;*</span>(storage <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr_in);
<a href=#198 id=198 data-nosnippet>198</a> <span class="kw">let </span>ip = Ipv4Addr::from(addr.sin_addr.s_addr.to_ne_bytes());
<a href=#199 id=199 data-nosnippet>199</a> <span class="kw">let </span>port = u16::from_be(addr.sin_port);
<a href=#200 id=200 data-nosnippet>200</a> <span class="prelude-val">Ok</span>(SocketAddr::V4(SocketAddrV4::new(ip, port)))
<a href=#201 id=201 data-nosnippet>201</a> }
<a href=#202 id=202 data-nosnippet>202</a> libc::AF_INET6 =&gt; {
<a href=#203 id=203 data-nosnippet>203</a> <span class="comment">// Safety: if the ss_family field is AF_INET6 then storage must be a sockaddr_in6.
<a href=#204 id=204 data-nosnippet>204</a> </span><span class="kw">let </span>addr: <span class="kw-2">&amp;</span>libc::sockaddr_in6 = <span class="kw-2">&amp;*</span>(storage <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr_in6);
<a href=#205 id=205 data-nosnippet>205</a> <span class="kw">let </span>ip = Ipv6Addr::from(addr.sin6_addr.s6_addr);
<a href=#206 id=206 data-nosnippet>206</a> <span class="kw">let </span>port = u16::from_be(addr.sin6_port);
<a href=#207 id=207 data-nosnippet>207</a> <span class="prelude-val">Ok</span>(SocketAddr::V6(SocketAddrV6::new(
<a href=#208 id=208 data-nosnippet>208</a> ip,
<a href=#209 id=209 data-nosnippet>209</a> port,
<a href=#210 id=210 data-nosnippet>210</a> addr.sin6_flowinfo,
<a href=#211 id=211 data-nosnippet>211</a> addr.sin6_scope_id,
<a href=#212 id=212 data-nosnippet>212</a> )))
<a href=#213 id=213 data-nosnippet>213</a> }
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(io::ErrorKind::InvalidInput.into()),
<a href=#215 id=215 data-nosnippet>215</a> }
<a href=#216 id=216 data-nosnippet>216</a>}
</code></pre></div></section></main></body></html>
+621
View File
@@ -0,0 +1,621 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/pipe.rs`."><title>pipe.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/</div>pipe.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Unix pipe.
<a href=#2 id=2 data-nosnippet>2</a>//!
<a href=#3 id=3 data-nosnippet>3</a>//! See the [`new`] function for documentation.
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a></span><span class="kw">use </span>std::io;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>std::os::fd::RawFd;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_raw() -&gt; io::Result&lt;[RawFd; <span class="number">2</span>]&gt; {
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">let </span><span class="kw-2">mut </span>fds: [RawFd; <span class="number">2</span>] = [-<span class="number">1</span>, -<span class="number">1</span>];
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a> <span class="attr">#[cfg(any(
<a href=#12 id=12 data-nosnippet>12</a> target_os = <span class="string">"android"</span>,
<a href=#13 id=13 data-nosnippet>13</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#14 id=14 data-nosnippet>14</a> target_os = <span class="string">"freebsd"</span>,
<a href=#15 id=15 data-nosnippet>15</a> target_os = <span class="string">"fuchsia"</span>,
<a href=#16 id=16 data-nosnippet>16</a> target_os = <span class="string">"hurd"</span>,
<a href=#17 id=17 data-nosnippet>17</a> target_os = <span class="string">"linux"</span>,
<a href=#18 id=18 data-nosnippet>18</a> target_os = <span class="string">"netbsd"</span>,
<a href=#19 id=19 data-nosnippet>19</a> target_os = <span class="string">"openbsd"</span>,
<a href=#20 id=20 data-nosnippet>20</a> target_os = <span class="string">"illumos"</span>,
<a href=#21 id=21 data-nosnippet>21</a> target_os = <span class="string">"redox"</span>,
<a href=#22 id=22 data-nosnippet>22</a> target_os = <span class="string">"solaris"</span>,
<a href=#23 id=23 data-nosnippet>23</a> target_os = <span class="string">"vita"</span>,
<a href=#24 id=24 data-nosnippet>24</a> target_os = <span class="string">"cygwin"</span>,
<a href=#25 id=25 data-nosnippet>25</a> ))]
<a href=#26 id=26 data-nosnippet>26</a> </span><span class="kw">unsafe </span>{
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">if </span>libc::pipe2(fds.as_mut_ptr(), libc::O_CLOEXEC | libc::O_NONBLOCK) != <span class="number">0 </span>{
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::last_os_error());
<a href=#29 id=29 data-nosnippet>29</a> }
<a href=#30 id=30 data-nosnippet>30</a> }
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="attr">#[cfg(any(
<a href=#33 id=33 data-nosnippet>33</a> target_os = <span class="string">"aix"</span>,
<a href=#34 id=34 data-nosnippet>34</a> target_os = <span class="string">"haiku"</span>,
<a href=#35 id=35 data-nosnippet>35</a> target_os = <span class="string">"ios"</span>,
<a href=#36 id=36 data-nosnippet>36</a> target_os = <span class="string">"macos"</span>,
<a href=#37 id=37 data-nosnippet>37</a> target_os = <span class="string">"tvos"</span>,
<a href=#38 id=38 data-nosnippet>38</a> target_os = <span class="string">"visionos"</span>,
<a href=#39 id=39 data-nosnippet>39</a> target_os = <span class="string">"watchos"</span>,
<a href=#40 id=40 data-nosnippet>40</a> target_os = <span class="string">"espidf"</span>,
<a href=#41 id=41 data-nosnippet>41</a> target_os = <span class="string">"nto"</span>,
<a href=#42 id=42 data-nosnippet>42</a> ))]
<a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">unsafe </span>{
<a href=#44 id=44 data-nosnippet>44</a> <span class="comment">// For platforms that don't have `pipe2(2)` we need to manually set the
<a href=#45 id=45 data-nosnippet>45</a> // correct flags on the file descriptor.
<a href=#46 id=46 data-nosnippet>46</a> </span><span class="kw">if </span>libc::pipe(fds.as_mut_ptr()) != <span class="number">0 </span>{
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::last_os_error());
<a href=#48 id=48 data-nosnippet>48</a> }
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">for </span>fd <span class="kw">in </span><span class="kw-2">&amp;</span>fds {
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">if </span>libc::fcntl(<span class="kw-2">*</span>fd, libc::F_SETFL, libc::O_NONBLOCK) != <span class="number">0
<a href=#52 id=52 data-nosnippet>52</a> </span>|| libc::fcntl(<span class="kw-2">*</span>fd, libc::F_SETFD, libc::FD_CLOEXEC) != <span class="number">0
<a href=#53 id=53 data-nosnippet>53</a> </span>{
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">let </span>err = io::Error::last_os_error();
<a href=#55 id=55 data-nosnippet>55</a> <span class="comment">// Don't leak file descriptors. Can't handle closing error though.
<a href=#56 id=56 data-nosnippet>56</a> </span><span class="kw">let _ </span>= libc::close(fds[<span class="number">0</span>]);
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let _ </span>= libc::close(fds[<span class="number">1</span>]);
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">return </span><span class="prelude-val">Err</span>(err);
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a> }
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="prelude-val">Ok</span>(fds)
<a href=#64 id=64 data-nosnippet>64</a>}
<a href=#65 id=65 data-nosnippet>65</a>
<a href=#66 id=66 data-nosnippet>66</a><span class="macro">cfg_os_ext!</span> {
<a href=#67 id=67 data-nosnippet>67</a><span class="kw">use </span>std::fs::File;
<a href=#68 id=68 data-nosnippet>68</a><span class="kw">use </span>std::io::{IoSlice, IoSliceMut, Read, Write};
<a href=#69 id=69 data-nosnippet>69</a><span class="kw">use </span>std::os::fd::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd};
<a href=#70 id=70 data-nosnippet>70</a><span class="kw">use </span>std::process::{ChildStderr, ChildStdin, ChildStdout};
<a href=#71 id=71 data-nosnippet>71</a>
<a href=#72 id=72 data-nosnippet>72</a><span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource;
<a href=#73 id=73 data-nosnippet>73</a><span class="kw">use crate</span>::{event, Interest, Registry, Token};
<a href=#74 id=74 data-nosnippet>74</a>
<a href=#75 id=75 data-nosnippet>75</a><span class="doccomment">/// Create a new non-blocking Unix pipe.
<a href=#76 id=76 data-nosnippet>76</a>///
<a href=#77 id=77 data-nosnippet>77</a>/// This is a wrapper around Unix's [`pipe(2)`] system call and can be used as
<a href=#78 id=78 data-nosnippet>78</a>/// inter-process or thread communication channel.
<a href=#79 id=79 data-nosnippet>79</a>///
<a href=#80 id=80 data-nosnippet>80</a>/// This channel may be created before forking the process and then one end used
<a href=#81 id=81 data-nosnippet>81</a>/// in each process, e.g. the parent process has the sending end to send command
<a href=#82 id=82 data-nosnippet>82</a>/// to the child process.
<a href=#83 id=83 data-nosnippet>83</a>///
<a href=#84 id=84 data-nosnippet>84</a>/// [`pipe(2)`]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/pipe.html
<a href=#85 id=85 data-nosnippet>85</a>///
<a href=#86 id=86 data-nosnippet>86</a>/// # Events
<a href=#87 id=87 data-nosnippet>87</a>///
<a href=#88 id=88 data-nosnippet>88</a>/// The [`Sender`] can be registered with [`WRITABLE`] interest to receive
<a href=#89 id=89 data-nosnippet>89</a>/// [writable events], the [`Receiver`] with [`READABLE`] interest. Once data is
<a href=#90 id=90 data-nosnippet>90</a>/// written to the `Sender` the `Receiver` will receive an [readable event].
<a href=#91 id=91 data-nosnippet>91</a>///
<a href=#92 id=92 data-nosnippet>92</a>/// In addition to those events, events will also be generated if the other side
<a href=#93 id=93 data-nosnippet>93</a>/// is dropped. To check if the `Sender` is dropped you'll need to check
<a href=#94 id=94 data-nosnippet>94</a>/// [`is_read_closed`] on events for the `Receiver`, if it returns true the
<a href=#95 id=95 data-nosnippet>95</a>/// `Sender` is dropped. On the `Sender` end check [`is_write_closed`], if it
<a href=#96 id=96 data-nosnippet>96</a>/// returns true the `Receiver` was dropped. Also see the second example below.
<a href=#97 id=97 data-nosnippet>97</a>///
<a href=#98 id=98 data-nosnippet>98</a>/// [`WRITABLE`]: Interest::WRITABLE
<a href=#99 id=99 data-nosnippet>99</a>/// [writable events]: event::Event::is_writable
<a href=#100 id=100 data-nosnippet>100</a>/// [`READABLE`]: Interest::READABLE
<a href=#101 id=101 data-nosnippet>101</a>/// [readable event]: event::Event::is_readable
<a href=#102 id=102 data-nosnippet>102</a>/// [`is_read_closed`]: event::Event::is_read_closed
<a href=#103 id=103 data-nosnippet>103</a>/// [`is_write_closed`]: event::Event::is_write_closed
<a href=#104 id=104 data-nosnippet>104</a>///
<a href=#105 id=105 data-nosnippet>105</a>/// # Deregistering
<a href=#106 id=106 data-nosnippet>106</a>///
<a href=#107 id=107 data-nosnippet>107</a>/// Both `Sender` and `Receiver` will deregister themselves when dropped,
<a href=#108 id=108 data-nosnippet>108</a>/// **iff** the file descriptors are not duplicated (via [`dup(2)`]).
<a href=#109 id=109 data-nosnippet>109</a>///
<a href=#110 id=110 data-nosnippet>110</a>/// [`dup(2)`]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/dup.html
<a href=#111 id=111 data-nosnippet>111</a>///
<a href=#112 id=112 data-nosnippet>112</a>/// # Examples
<a href=#113 id=113 data-nosnippet>113</a>///
<a href=#114 id=114 data-nosnippet>114</a>/// Simple example that writes data into the sending end and read it from the
<a href=#115 id=115 data-nosnippet>115</a>/// receiving end.
<a href=#116 id=116 data-nosnippet>116</a>///
<a href=#117 id=117 data-nosnippet>117</a>/// ```
<a href=#118 id=118 data-nosnippet>118</a>/// use std::io::{self, Read, Write};
<a href=#119 id=119 data-nosnippet>119</a>///
<a href=#120 id=120 data-nosnippet>120</a>/// use mio::{Poll, Events, Interest, Token};
<a href=#121 id=121 data-nosnippet>121</a>/// use mio::unix::pipe;
<a href=#122 id=122 data-nosnippet>122</a>///
<a href=#123 id=123 data-nosnippet>123</a>/// // Unique tokens for the two ends of the channel.
<a href=#124 id=124 data-nosnippet>124</a>/// const PIPE_RECV: Token = Token(0);
<a href=#125 id=125 data-nosnippet>125</a>/// const PIPE_SEND: Token = Token(1);
<a href=#126 id=126 data-nosnippet>126</a>///
<a href=#127 id=127 data-nosnippet>127</a>/// # fn main() -&gt; io::Result&lt;()&gt; {
<a href=#128 id=128 data-nosnippet>128</a>/// // Create our `Poll` instance and the `Events` container.
<a href=#129 id=129 data-nosnippet>129</a>/// let mut poll = Poll::new()?;
<a href=#130 id=130 data-nosnippet>130</a>/// let mut events = Events::with_capacity(8);
<a href=#131 id=131 data-nosnippet>131</a>///
<a href=#132 id=132 data-nosnippet>132</a>/// // Create a new pipe.
<a href=#133 id=133 data-nosnippet>133</a>/// let (mut sender, mut receiver) = pipe::new()?;
<a href=#134 id=134 data-nosnippet>134</a>///
<a href=#135 id=135 data-nosnippet>135</a>/// // Register both ends of the channel.
<a href=#136 id=136 data-nosnippet>136</a>/// poll.registry().register(&amp;mut receiver, PIPE_RECV, Interest::READABLE)?;
<a href=#137 id=137 data-nosnippet>137</a>/// poll.registry().register(&amp;mut sender, PIPE_SEND, Interest::WRITABLE)?;
<a href=#138 id=138 data-nosnippet>138</a>///
<a href=#139 id=139 data-nosnippet>139</a>/// const MSG: &amp;[u8; 11] = b"Hello world";
<a href=#140 id=140 data-nosnippet>140</a>///
<a href=#141 id=141 data-nosnippet>141</a>/// loop {
<a href=#142 id=142 data-nosnippet>142</a>/// poll.poll(&amp;mut events, None)?;
<a href=#143 id=143 data-nosnippet>143</a>///
<a href=#144 id=144 data-nosnippet>144</a>/// for event in events.iter() {
<a href=#145 id=145 data-nosnippet>145</a>/// match event.token() {
<a href=#146 id=146 data-nosnippet>146</a>/// PIPE_SEND =&gt; sender.write(MSG)
<a href=#147 id=147 data-nosnippet>147</a>/// .and_then(|n| if n != MSG.len() {
<a href=#148 id=148 data-nosnippet>148</a>/// // We'll consider a short write an error in this
<a href=#149 id=149 data-nosnippet>149</a>/// // example. NOTE: we can't use `write_all` with
<a href=#150 id=150 data-nosnippet>150</a>/// // non-blocking I/O.
<a href=#151 id=151 data-nosnippet>151</a>/// Err(io::ErrorKind::WriteZero.into())
<a href=#152 id=152 data-nosnippet>152</a>/// } else {
<a href=#153 id=153 data-nosnippet>153</a>/// Ok(())
<a href=#154 id=154 data-nosnippet>154</a>/// })?,
<a href=#155 id=155 data-nosnippet>155</a>/// PIPE_RECV =&gt; {
<a href=#156 id=156 data-nosnippet>156</a>/// let mut buf = [0; 11];
<a href=#157 id=157 data-nosnippet>157</a>/// let n = receiver.read(&amp;mut buf)?;
<a href=#158 id=158 data-nosnippet>158</a>/// println!("received: {:?}", &amp;buf[0..n]);
<a href=#159 id=159 data-nosnippet>159</a>/// assert_eq!(n, MSG.len());
<a href=#160 id=160 data-nosnippet>160</a>/// assert_eq!(&amp;buf, &amp;*MSG);
<a href=#161 id=161 data-nosnippet>161</a>/// return Ok(());
<a href=#162 id=162 data-nosnippet>162</a>/// },
<a href=#163 id=163 data-nosnippet>163</a>/// _ =&gt; unreachable!(),
<a href=#164 id=164 data-nosnippet>164</a>/// }
<a href=#165 id=165 data-nosnippet>165</a>/// }
<a href=#166 id=166 data-nosnippet>166</a>/// }
<a href=#167 id=167 data-nosnippet>167</a>/// # }
<a href=#168 id=168 data-nosnippet>168</a>/// ```
<a href=#169 id=169 data-nosnippet>169</a>///
<a href=#170 id=170 data-nosnippet>170</a>/// Example that receives an event once the `Sender` is dropped.
<a href=#171 id=171 data-nosnippet>171</a>///
<a href=#172 id=172 data-nosnippet>172</a>/// ```
<a href=#173 id=173 data-nosnippet>173</a>/// # use std::io;
<a href=#174 id=174 data-nosnippet>174</a>/// #
<a href=#175 id=175 data-nosnippet>175</a>/// # use mio::{Poll, Events, Interest, Token};
<a href=#176 id=176 data-nosnippet>176</a>/// # use mio::unix::pipe;
<a href=#177 id=177 data-nosnippet>177</a>/// #
<a href=#178 id=178 data-nosnippet>178</a>/// # const PIPE_RECV: Token = Token(0);
<a href=#179 id=179 data-nosnippet>179</a>/// # const PIPE_SEND: Token = Token(1);
<a href=#180 id=180 data-nosnippet>180</a>/// #
<a href=#181 id=181 data-nosnippet>181</a>/// # fn main() -&gt; io::Result&lt;()&gt; {
<a href=#182 id=182 data-nosnippet>182</a>/// // Same setup as in the example above.
<a href=#183 id=183 data-nosnippet>183</a>/// let mut poll = Poll::new()?;
<a href=#184 id=184 data-nosnippet>184</a>/// let mut events = Events::with_capacity(8);
<a href=#185 id=185 data-nosnippet>185</a>///
<a href=#186 id=186 data-nosnippet>186</a>/// let (mut sender, mut receiver) = pipe::new()?;
<a href=#187 id=187 data-nosnippet>187</a>///
<a href=#188 id=188 data-nosnippet>188</a>/// poll.registry().register(&amp;mut receiver, PIPE_RECV, Interest::READABLE)?;
<a href=#189 id=189 data-nosnippet>189</a>/// poll.registry().register(&amp;mut sender, PIPE_SEND, Interest::WRITABLE)?;
<a href=#190 id=190 data-nosnippet>190</a>///
<a href=#191 id=191 data-nosnippet>191</a>/// // Drop the sender.
<a href=#192 id=192 data-nosnippet>192</a>/// drop(sender);
<a href=#193 id=193 data-nosnippet>193</a>///
<a href=#194 id=194 data-nosnippet>194</a>/// poll.poll(&amp;mut events, None)?;
<a href=#195 id=195 data-nosnippet>195</a>///
<a href=#196 id=196 data-nosnippet>196</a>/// for event in events.iter() {
<a href=#197 id=197 data-nosnippet>197</a>/// match event.token() {
<a href=#198 id=198 data-nosnippet>198</a>/// PIPE_RECV if event.is_read_closed() =&gt; {
<a href=#199 id=199 data-nosnippet>199</a>/// // Detected that the sender was dropped.
<a href=#200 id=200 data-nosnippet>200</a>/// println!("Sender dropped!");
<a href=#201 id=201 data-nosnippet>201</a>/// return Ok(());
<a href=#202 id=202 data-nosnippet>202</a>/// },
<a href=#203 id=203 data-nosnippet>203</a>/// _ =&gt; unreachable!(),
<a href=#204 id=204 data-nosnippet>204</a>/// }
<a href=#205 id=205 data-nosnippet>205</a>/// }
<a href=#206 id=206 data-nosnippet>206</a>/// # unreachable!();
<a href=#207 id=207 data-nosnippet>207</a>/// # }
<a href=#208 id=208 data-nosnippet>208</a>/// ```
<a href=#209 id=209 data-nosnippet>209</a></span><span class="kw">pub fn </span>new() -&gt; io::Result&lt;(Sender, Receiver)&gt; {
<a href=#210 id=210 data-nosnippet>210</a> <span class="kw">let </span>fds = new_raw()<span class="question-mark">?</span>;
<a href=#211 id=211 data-nosnippet>211</a> <span class="comment">// SAFETY: `new_raw` initialised the `fds` above.
<a href=#212 id=212 data-nosnippet>212</a> </span><span class="kw">let </span>r = <span class="kw">unsafe </span>{ Receiver::from_raw_fd(fds[<span class="number">0</span>]) };
<a href=#213 id=213 data-nosnippet>213</a> <span class="kw">let </span>w = <span class="kw">unsafe </span>{ Sender::from_raw_fd(fds[<span class="number">1</span>]) };
<a href=#214 id=214 data-nosnippet>214</a> <span class="prelude-val">Ok</span>((w, r))
<a href=#215 id=215 data-nosnippet>215</a>}
<a href=#216 id=216 data-nosnippet>216</a>
<a href=#217 id=217 data-nosnippet>217</a><span class="doccomment">/// Sending end of an Unix pipe.
<a href=#218 id=218 data-nosnippet>218</a>///
<a href=#219 id=219 data-nosnippet>219</a>/// See [`new`] for documentation, including examples.
<a href=#220 id=220 data-nosnippet>220</a></span><span class="attr">#[derive(Debug)]
<a href=#221 id=221 data-nosnippet>221</a></span><span class="kw">pub struct </span>Sender {
<a href=#222 id=222 data-nosnippet>222</a> inner: IoSource&lt;File&gt;,
<a href=#223 id=223 data-nosnippet>223</a>}
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a><span class="kw">impl </span>Sender {
<a href=#226 id=226 data-nosnippet>226</a> <span class="doccomment">/// Set the `Sender` into or out of non-blocking mode.
<a href=#227 id=227 data-nosnippet>227</a> </span><span class="kw">pub fn </span>set_nonblocking(<span class="kw-2">&amp;</span><span class="self">self</span>, nonblocking: bool) -&gt; io::Result&lt;()&gt; {
<a href=#228 id=228 data-nosnippet>228</a> set_nonblocking(<span class="self">self</span>.inner.as_raw_fd(), nonblocking)
<a href=#229 id=229 data-nosnippet>229</a> }
<a href=#230 id=230 data-nosnippet>230</a>
<a href=#231 id=231 data-nosnippet>231</a> <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events
<a href=#232 id=232 data-nosnippet>232</a> /// if it hits a [`WouldBlock`] error.
<a href=#233 id=233 data-nosnippet>233</a> ///
<a href=#234 id=234 data-nosnippet>234</a> /// # Notes
<a href=#235 id=235 data-nosnippet>235</a> ///
<a href=#236 id=236 data-nosnippet>236</a> /// This method is required to be called for **all** I/O operations to
<a href=#237 id=237 data-nosnippet>237</a> /// ensure the user will receive events once the socket is ready again after
<a href=#238 id=238 data-nosnippet>238</a> /// returning a [`WouldBlock`] error.
<a href=#239 id=239 data-nosnippet>239</a> ///
<a href=#240 id=240 data-nosnippet>240</a> /// [`WouldBlock`]: io::ErrorKind::WouldBlock
<a href=#241 id=241 data-nosnippet>241</a> ///
<a href=#242 id=242 data-nosnippet>242</a> /// # Examples
<a href=#243 id=243 data-nosnippet>243</a> ///
<a href=#244 id=244 data-nosnippet>244</a> /// ```
<a href=#245 id=245 data-nosnippet>245</a> /// # use std::error::Error;
<a href=#246 id=246 data-nosnippet>246</a> /// #
<a href=#247 id=247 data-nosnippet>247</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#248 id=248 data-nosnippet>248</a> /// use std::io;
<a href=#249 id=249 data-nosnippet>249</a> /// use std::os::fd::AsRawFd;
<a href=#250 id=250 data-nosnippet>250</a> /// use mio::unix::pipe;
<a href=#251 id=251 data-nosnippet>251</a> ///
<a href=#252 id=252 data-nosnippet>252</a> /// let (sender, receiver) = pipe::new()?;
<a href=#253 id=253 data-nosnippet>253</a> ///
<a href=#254 id=254 data-nosnippet>254</a> /// // Wait until the sender is writable...
<a href=#255 id=255 data-nosnippet>255</a> ///
<a href=#256 id=256 data-nosnippet>256</a> /// // Write to the sender using a direct libc call, of course the
<a href=#257 id=257 data-nosnippet>257</a> /// // `io::Write` implementation would be easier to use.
<a href=#258 id=258 data-nosnippet>258</a> /// let buf = b"hello";
<a href=#259 id=259 data-nosnippet>259</a> /// let n = sender.try_io(|| {
<a href=#260 id=260 data-nosnippet>260</a> /// let buf_ptr = &amp;buf as *const _ as *const _;
<a href=#261 id=261 data-nosnippet>261</a> /// let res = unsafe { libc::write(sender.as_raw_fd(), buf_ptr, buf.len()) };
<a href=#262 id=262 data-nosnippet>262</a> /// if res != -1 {
<a href=#263 id=263 data-nosnippet>263</a> /// Ok(res as usize)
<a href=#264 id=264 data-nosnippet>264</a> /// } else {
<a href=#265 id=265 data-nosnippet>265</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::write, the closure
<a href=#266 id=266 data-nosnippet>266</a> /// // should return `WouldBlock` error.
<a href=#267 id=267 data-nosnippet>267</a> /// Err(io::Error::last_os_error())
<a href=#268 id=268 data-nosnippet>268</a> /// }
<a href=#269 id=269 data-nosnippet>269</a> /// })?;
<a href=#270 id=270 data-nosnippet>270</a> /// eprintln!("write {} bytes", n);
<a href=#271 id=271 data-nosnippet>271</a> ///
<a href=#272 id=272 data-nosnippet>272</a> /// // Wait until the receiver is readable...
<a href=#273 id=273 data-nosnippet>273</a> ///
<a href=#274 id=274 data-nosnippet>274</a> /// // Read from the receiver using a direct libc call, of course the
<a href=#275 id=275 data-nosnippet>275</a> /// // `io::Read` implementation would be easier to use.
<a href=#276 id=276 data-nosnippet>276</a> /// let mut buf = [0; 512];
<a href=#277 id=277 data-nosnippet>277</a> /// let n = receiver.try_io(|| {
<a href=#278 id=278 data-nosnippet>278</a> /// let buf_ptr = &amp;mut buf as *mut _ as *mut _;
<a href=#279 id=279 data-nosnippet>279</a> /// let res = unsafe { libc::read(receiver.as_raw_fd(), buf_ptr, buf.len()) };
<a href=#280 id=280 data-nosnippet>280</a> /// if res != -1 {
<a href=#281 id=281 data-nosnippet>281</a> /// Ok(res as usize)
<a href=#282 id=282 data-nosnippet>282</a> /// } else {
<a href=#283 id=283 data-nosnippet>283</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::read, the closure
<a href=#284 id=284 data-nosnippet>284</a> /// // should return `WouldBlock` error.
<a href=#285 id=285 data-nosnippet>285</a> /// Err(io::Error::last_os_error())
<a href=#286 id=286 data-nosnippet>286</a> /// }
<a href=#287 id=287 data-nosnippet>287</a> /// })?;
<a href=#288 id=288 data-nosnippet>288</a> /// eprintln!("read {} bytes", n);
<a href=#289 id=289 data-nosnippet>289</a> /// # Ok(())
<a href=#290 id=290 data-nosnippet>290</a> /// # }
<a href=#291 id=291 data-nosnippet>291</a> /// ```
<a href=#292 id=292 data-nosnippet>292</a> </span><span class="kw">pub fn </span>try_io&lt;F, T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; io::Result&lt;T&gt;
<a href=#293 id=293 data-nosnippet>293</a> <span class="kw">where
<a href=#294 id=294 data-nosnippet>294</a> </span>F: FnOnce() -&gt; io::Result&lt;T&gt;,
<a href=#295 id=295 data-nosnippet>295</a> {
<a href=#296 id=296 data-nosnippet>296</a> <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f())
<a href=#297 id=297 data-nosnippet>297</a> }
<a href=#298 id=298 data-nosnippet>298</a>}
<a href=#299 id=299 data-nosnippet>299</a>
<a href=#300 id=300 data-nosnippet>300</a><span class="kw">impl </span>event::Source <span class="kw">for </span>Sender {
<a href=#301 id=301 data-nosnippet>301</a> <span class="kw">fn </span>register(
<a href=#302 id=302 data-nosnippet>302</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#303 id=303 data-nosnippet>303</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#304 id=304 data-nosnippet>304</a> token: Token,
<a href=#305 id=305 data-nosnippet>305</a> interests: Interest,
<a href=#306 id=306 data-nosnippet>306</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#307 id=307 data-nosnippet>307</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#308 id=308 data-nosnippet>308</a> }
<a href=#309 id=309 data-nosnippet>309</a>
<a href=#310 id=310 data-nosnippet>310</a> <span class="kw">fn </span>reregister(
<a href=#311 id=311 data-nosnippet>311</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#312 id=312 data-nosnippet>312</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#313 id=313 data-nosnippet>313</a> token: Token,
<a href=#314 id=314 data-nosnippet>314</a> interests: Interest,
<a href=#315 id=315 data-nosnippet>315</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#316 id=316 data-nosnippet>316</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#317 id=317 data-nosnippet>317</a> }
<a href=#318 id=318 data-nosnippet>318</a>
<a href=#319 id=319 data-nosnippet>319</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#320 id=320 data-nosnippet>320</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#321 id=321 data-nosnippet>321</a> }
<a href=#322 id=322 data-nosnippet>322</a>}
<a href=#323 id=323 data-nosnippet>323</a>
<a href=#324 id=324 data-nosnippet>324</a><span class="kw">impl </span>Write <span class="kw">for </span>Sender {
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#326 id=326 data-nosnippet>326</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.write(buf))
<a href=#327 id=327 data-nosnippet>327</a> }
<a href=#328 id=328 data-nosnippet>328</a>
<a href=#329 id=329 data-nosnippet>329</a> <span class="kw">fn </span>write_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#330 id=330 data-nosnippet>330</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.write_vectored(bufs))
<a href=#331 id=331 data-nosnippet>331</a> }
<a href=#332 id=332 data-nosnippet>332</a>
<a href=#333 id=333 data-nosnippet>333</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#334 id=334 data-nosnippet>334</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.flush())
<a href=#335 id=335 data-nosnippet>335</a> }
<a href=#336 id=336 data-nosnippet>336</a>}
<a href=#337 id=337 data-nosnippet>337</a>
<a href=#338 id=338 data-nosnippet>338</a><span class="kw">impl </span>Write <span class="kw">for </span><span class="kw-2">&amp;</span>Sender {
<a href=#339 id=339 data-nosnippet>339</a> <span class="kw">fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#340 id=340 data-nosnippet>340</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.write(buf))
<a href=#341 id=341 data-nosnippet>341</a> }
<a href=#342 id=342 data-nosnippet>342</a>
<a href=#343 id=343 data-nosnippet>343</a> <span class="kw">fn </span>write_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;</span>[IoSlice&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#344 id=344 data-nosnippet>344</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.write_vectored(bufs))
<a href=#345 id=345 data-nosnippet>345</a> }
<a href=#346 id=346 data-nosnippet>346</a>
<a href=#347 id=347 data-nosnippet>347</a> <span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#348 id=348 data-nosnippet>348</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.flush())
<a href=#349 id=349 data-nosnippet>349</a> }
<a href=#350 id=350 data-nosnippet>350</a>}
<a href=#351 id=351 data-nosnippet>351</a>
<a href=#352 id=352 data-nosnippet>352</a><span class="doccomment">/// # Notes
<a href=#353 id=353 data-nosnippet>353</a>///
<a href=#354 id=354 data-nosnippet>354</a>/// The underlying pipe is **not** set to non-blocking.
<a href=#355 id=355 data-nosnippet>355</a></span><span class="kw">impl </span>From&lt;ChildStdin&gt; <span class="kw">for </span>Sender {
<a href=#356 id=356 data-nosnippet>356</a> <span class="kw">fn </span>from(stdin: ChildStdin) -&gt; Sender {
<a href=#357 id=357 data-nosnippet>357</a> <span class="comment">// Safety: `ChildStdin` is guaranteed to be a valid file descriptor.
<a href=#358 id=358 data-nosnippet>358</a> </span><span class="kw">unsafe </span>{ Sender::from_raw_fd(stdin.into_raw_fd()) }
<a href=#359 id=359 data-nosnippet>359</a> }
<a href=#360 id=360 data-nosnippet>360</a>}
<a href=#361 id=361 data-nosnippet>361</a>
<a href=#362 id=362 data-nosnippet>362</a><span class="kw">impl </span>FromRawFd <span class="kw">for </span>Sender {
<a href=#363 id=363 data-nosnippet>363</a> <span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; Sender {
<a href=#364 id=364 data-nosnippet>364</a> Sender {
<a href=#365 id=365 data-nosnippet>365</a> inner: IoSource::new(File::from_raw_fd(fd)),
<a href=#366 id=366 data-nosnippet>366</a> }
<a href=#367 id=367 data-nosnippet>367</a> }
<a href=#368 id=368 data-nosnippet>368</a>}
<a href=#369 id=369 data-nosnippet>369</a>
<a href=#370 id=370 data-nosnippet>370</a><span class="kw">impl </span>AsRawFd <span class="kw">for </span>Sender {
<a href=#371 id=371 data-nosnippet>371</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#372 id=372 data-nosnippet>372</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#373 id=373 data-nosnippet>373</a> }
<a href=#374 id=374 data-nosnippet>374</a>}
<a href=#375 id=375 data-nosnippet>375</a>
<a href=#376 id=376 data-nosnippet>376</a><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>Sender {
<a href=#377 id=377 data-nosnippet>377</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#378 id=378 data-nosnippet>378</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#379 id=379 data-nosnippet>379</a> }
<a href=#380 id=380 data-nosnippet>380</a>}
<a href=#381 id=381 data-nosnippet>381</a>
<a href=#382 id=382 data-nosnippet>382</a><span class="kw">impl </span>From&lt;Sender&gt; <span class="kw">for </span>OwnedFd {
<a href=#383 id=383 data-nosnippet>383</a> <span class="kw">fn </span>from(sender: Sender) -&gt; <span class="self">Self </span>{
<a href=#384 id=384 data-nosnippet>384</a> sender.inner.into_inner().into()
<a href=#385 id=385 data-nosnippet>385</a> }
<a href=#386 id=386 data-nosnippet>386</a>}
<a href=#387 id=387 data-nosnippet>387</a>
<a href=#388 id=388 data-nosnippet>388</a><span class="kw">impl </span>AsFd <span class="kw">for </span>Sender {
<a href=#389 id=389 data-nosnippet>389</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#390 id=390 data-nosnippet>390</a> <span class="self">self</span>.inner.as_fd()
<a href=#391 id=391 data-nosnippet>391</a> }
<a href=#392 id=392 data-nosnippet>392</a>}
<a href=#393 id=393 data-nosnippet>393</a>
<a href=#394 id=394 data-nosnippet>394</a><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>Sender {
<a href=#395 id=395 data-nosnippet>395</a> <span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#396 id=396 data-nosnippet>396</a> Sender {
<a href=#397 id=397 data-nosnippet>397</a> inner: IoSource::new(File::from(fd)),
<a href=#398 id=398 data-nosnippet>398</a> }
<a href=#399 id=399 data-nosnippet>399</a> }
<a href=#400 id=400 data-nosnippet>400</a>}
<a href=#401 id=401 data-nosnippet>401</a>
<a href=#402 id=402 data-nosnippet>402</a><span class="doccomment">/// Receiving end of an Unix pipe.
<a href=#403 id=403 data-nosnippet>403</a>///
<a href=#404 id=404 data-nosnippet>404</a>/// See [`new`] for documentation, including examples.
<a href=#405 id=405 data-nosnippet>405</a></span><span class="attr">#[derive(Debug)]
<a href=#406 id=406 data-nosnippet>406</a></span><span class="kw">pub struct </span>Receiver {
<a href=#407 id=407 data-nosnippet>407</a> inner: IoSource&lt;File&gt;,
<a href=#408 id=408 data-nosnippet>408</a>}
<a href=#409 id=409 data-nosnippet>409</a>
<a href=#410 id=410 data-nosnippet>410</a><span class="kw">impl </span>Receiver {
<a href=#411 id=411 data-nosnippet>411</a> <span class="doccomment">/// Set the `Receiver` into or out of non-blocking mode.
<a href=#412 id=412 data-nosnippet>412</a> </span><span class="kw">pub fn </span>set_nonblocking(<span class="kw-2">&amp;</span><span class="self">self</span>, nonblocking: bool) -&gt; io::Result&lt;()&gt; {
<a href=#413 id=413 data-nosnippet>413</a> set_nonblocking(<span class="self">self</span>.inner.as_raw_fd(), nonblocking)
<a href=#414 id=414 data-nosnippet>414</a> }
<a href=#415 id=415 data-nosnippet>415</a>
<a href=#416 id=416 data-nosnippet>416</a> <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events
<a href=#417 id=417 data-nosnippet>417</a> /// if it hits a [`WouldBlock`] error.
<a href=#418 id=418 data-nosnippet>418</a> ///
<a href=#419 id=419 data-nosnippet>419</a> /// # Notes
<a href=#420 id=420 data-nosnippet>420</a> ///
<a href=#421 id=421 data-nosnippet>421</a> /// This method is required to be called for **all** I/O operations to
<a href=#422 id=422 data-nosnippet>422</a> /// ensure the user will receive events once the socket is ready again after
<a href=#423 id=423 data-nosnippet>423</a> /// returning a [`WouldBlock`] error.
<a href=#424 id=424 data-nosnippet>424</a> ///
<a href=#425 id=425 data-nosnippet>425</a> /// [`WouldBlock`]: io::ErrorKind::WouldBlock
<a href=#426 id=426 data-nosnippet>426</a> ///
<a href=#427 id=427 data-nosnippet>427</a> /// # Examples
<a href=#428 id=428 data-nosnippet>428</a> ///
<a href=#429 id=429 data-nosnippet>429</a> /// ```
<a href=#430 id=430 data-nosnippet>430</a> /// # use std::error::Error;
<a href=#431 id=431 data-nosnippet>431</a> /// #
<a href=#432 id=432 data-nosnippet>432</a> /// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#433 id=433 data-nosnippet>433</a> /// use std::io;
<a href=#434 id=434 data-nosnippet>434</a> /// use std::os::fd::AsRawFd;
<a href=#435 id=435 data-nosnippet>435</a> /// use mio::unix::pipe;
<a href=#436 id=436 data-nosnippet>436</a> ///
<a href=#437 id=437 data-nosnippet>437</a> /// let (sender, receiver) = pipe::new()?;
<a href=#438 id=438 data-nosnippet>438</a> ///
<a href=#439 id=439 data-nosnippet>439</a> /// // Wait until the sender is writable...
<a href=#440 id=440 data-nosnippet>440</a> ///
<a href=#441 id=441 data-nosnippet>441</a> /// // Write to the sender using a direct libc call, of course the
<a href=#442 id=442 data-nosnippet>442</a> /// // `io::Write` implementation would be easier to use.
<a href=#443 id=443 data-nosnippet>443</a> /// let buf = b"hello";
<a href=#444 id=444 data-nosnippet>444</a> /// let n = sender.try_io(|| {
<a href=#445 id=445 data-nosnippet>445</a> /// let buf_ptr = &amp;buf as *const _ as *const _;
<a href=#446 id=446 data-nosnippet>446</a> /// let res = unsafe { libc::write(sender.as_raw_fd(), buf_ptr, buf.len()) };
<a href=#447 id=447 data-nosnippet>447</a> /// if res != -1 {
<a href=#448 id=448 data-nosnippet>448</a> /// Ok(res as usize)
<a href=#449 id=449 data-nosnippet>449</a> /// } else {
<a href=#450 id=450 data-nosnippet>450</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::write, the closure
<a href=#451 id=451 data-nosnippet>451</a> /// // should return `WouldBlock` error.
<a href=#452 id=452 data-nosnippet>452</a> /// Err(io::Error::last_os_error())
<a href=#453 id=453 data-nosnippet>453</a> /// }
<a href=#454 id=454 data-nosnippet>454</a> /// })?;
<a href=#455 id=455 data-nosnippet>455</a> /// eprintln!("write {} bytes", n);
<a href=#456 id=456 data-nosnippet>456</a> ///
<a href=#457 id=457 data-nosnippet>457</a> /// // Wait until the receiver is readable...
<a href=#458 id=458 data-nosnippet>458</a> ///
<a href=#459 id=459 data-nosnippet>459</a> /// // Read from the receiver using a direct libc call, of course the
<a href=#460 id=460 data-nosnippet>460</a> /// // `io::Read` implementation would be easier to use.
<a href=#461 id=461 data-nosnippet>461</a> /// let mut buf = [0; 512];
<a href=#462 id=462 data-nosnippet>462</a> /// let n = receiver.try_io(|| {
<a href=#463 id=463 data-nosnippet>463</a> /// let buf_ptr = &amp;mut buf as *mut _ as *mut _;
<a href=#464 id=464 data-nosnippet>464</a> /// let res = unsafe { libc::read(receiver.as_raw_fd(), buf_ptr, buf.len()) };
<a href=#465 id=465 data-nosnippet>465</a> /// if res != -1 {
<a href=#466 id=466 data-nosnippet>466</a> /// Ok(res as usize)
<a href=#467 id=467 data-nosnippet>467</a> /// } else {
<a href=#468 id=468 data-nosnippet>468</a> /// // If EAGAIN or EWOULDBLOCK is set by libc::read, the closure
<a href=#469 id=469 data-nosnippet>469</a> /// // should return `WouldBlock` error.
<a href=#470 id=470 data-nosnippet>470</a> /// Err(io::Error::last_os_error())
<a href=#471 id=471 data-nosnippet>471</a> /// }
<a href=#472 id=472 data-nosnippet>472</a> /// })?;
<a href=#473 id=473 data-nosnippet>473</a> /// eprintln!("read {} bytes", n);
<a href=#474 id=474 data-nosnippet>474</a> /// # Ok(())
<a href=#475 id=475 data-nosnippet>475</a> /// # }
<a href=#476 id=476 data-nosnippet>476</a> /// ```
<a href=#477 id=477 data-nosnippet>477</a> </span><span class="kw">pub fn </span>try_io&lt;F, T&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F) -&gt; io::Result&lt;T&gt;
<a href=#478 id=478 data-nosnippet>478</a> <span class="kw">where
<a href=#479 id=479 data-nosnippet>479</a> </span>F: FnOnce() -&gt; io::Result&lt;T&gt;,
<a href=#480 id=480 data-nosnippet>480</a> {
<a href=#481 id=481 data-nosnippet>481</a> <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f())
<a href=#482 id=482 data-nosnippet>482</a> }
<a href=#483 id=483 data-nosnippet>483</a>}
<a href=#484 id=484 data-nosnippet>484</a>
<a href=#485 id=485 data-nosnippet>485</a><span class="kw">impl </span>event::Source <span class="kw">for </span>Receiver {
<a href=#486 id=486 data-nosnippet>486</a> <span class="kw">fn </span>register(
<a href=#487 id=487 data-nosnippet>487</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#488 id=488 data-nosnippet>488</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#489 id=489 data-nosnippet>489</a> token: Token,
<a href=#490 id=490 data-nosnippet>490</a> interests: Interest,
<a href=#491 id=491 data-nosnippet>491</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#492 id=492 data-nosnippet>492</a> <span class="self">self</span>.inner.register(registry, token, interests)
<a href=#493 id=493 data-nosnippet>493</a> }
<a href=#494 id=494 data-nosnippet>494</a>
<a href=#495 id=495 data-nosnippet>495</a> <span class="kw">fn </span>reregister(
<a href=#496 id=496 data-nosnippet>496</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#497 id=497 data-nosnippet>497</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#498 id=498 data-nosnippet>498</a> token: Token,
<a href=#499 id=499 data-nosnippet>499</a> interests: Interest,
<a href=#500 id=500 data-nosnippet>500</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#501 id=501 data-nosnippet>501</a> <span class="self">self</span>.inner.reregister(registry, token, interests)
<a href=#502 id=502 data-nosnippet>502</a> }
<a href=#503 id=503 data-nosnippet>503</a>
<a href=#504 id=504 data-nosnippet>504</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#505 id=505 data-nosnippet>505</a> <span class="self">self</span>.inner.deregister(registry)
<a href=#506 id=506 data-nosnippet>506</a> }
<a href=#507 id=507 data-nosnippet>507</a>}
<a href=#508 id=508 data-nosnippet>508</a>
<a href=#509 id=509 data-nosnippet>509</a><span class="kw">impl </span>Read <span class="kw">for </span>Receiver {
<a href=#510 id=510 data-nosnippet>510</a> <span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#511 id=511 data-nosnippet>511</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.read(buf))
<a href=#512 id=512 data-nosnippet>512</a> }
<a href=#513 id=513 data-nosnippet>513</a>
<a href=#514 id=514 data-nosnippet>514</a> <span class="kw">fn </span>read_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;mut </span>[IoSliceMut&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#515 id=515 data-nosnippet>515</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.read_vectored(bufs))
<a href=#516 id=516 data-nosnippet>516</a> }
<a href=#517 id=517 data-nosnippet>517</a>}
<a href=#518 id=518 data-nosnippet>518</a>
<a href=#519 id=519 data-nosnippet>519</a><span class="kw">impl </span>Read <span class="kw">for </span><span class="kw-2">&amp;</span>Receiver {
<a href=#520 id=520 data-nosnippet>520</a> <span class="kw">fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; io::Result&lt;usize&gt; {
<a href=#521 id=521 data-nosnippet>521</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.read(buf))
<a href=#522 id=522 data-nosnippet>522</a> }
<a href=#523 id=523 data-nosnippet>523</a>
<a href=#524 id=524 data-nosnippet>524</a> <span class="kw">fn </span>read_vectored(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bufs: <span class="kw-2">&amp;mut </span>[IoSliceMut&lt;<span class="lifetime">'_</span>&gt;]) -&gt; io::Result&lt;usize&gt; {
<a href=#525 id=525 data-nosnippet>525</a> <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>sender| sender.read_vectored(bufs))
<a href=#526 id=526 data-nosnippet>526</a> }
<a href=#527 id=527 data-nosnippet>527</a>}
<a href=#528 id=528 data-nosnippet>528</a>
<a href=#529 id=529 data-nosnippet>529</a><span class="doccomment">/// # Notes
<a href=#530 id=530 data-nosnippet>530</a>///
<a href=#531 id=531 data-nosnippet>531</a>/// The underlying pipe is **not** set to non-blocking.
<a href=#532 id=532 data-nosnippet>532</a></span><span class="kw">impl </span>From&lt;ChildStdout&gt; <span class="kw">for </span>Receiver {
<a href=#533 id=533 data-nosnippet>533</a> <span class="kw">fn </span>from(stdout: ChildStdout) -&gt; Receiver {
<a href=#534 id=534 data-nosnippet>534</a> <span class="comment">// Safety: `ChildStdout` is guaranteed to be a valid file descriptor.
<a href=#535 id=535 data-nosnippet>535</a> </span><span class="kw">unsafe </span>{ Receiver::from_raw_fd(stdout.into_raw_fd()) }
<a href=#536 id=536 data-nosnippet>536</a> }
<a href=#537 id=537 data-nosnippet>537</a>}
<a href=#538 id=538 data-nosnippet>538</a>
<a href=#539 id=539 data-nosnippet>539</a><span class="doccomment">/// # Notes
<a href=#540 id=540 data-nosnippet>540</a>///
<a href=#541 id=541 data-nosnippet>541</a>/// The underlying pipe is **not** set to non-blocking.
<a href=#542 id=542 data-nosnippet>542</a></span><span class="kw">impl </span>From&lt;ChildStderr&gt; <span class="kw">for </span>Receiver {
<a href=#543 id=543 data-nosnippet>543</a> <span class="kw">fn </span>from(stderr: ChildStderr) -&gt; Receiver {
<a href=#544 id=544 data-nosnippet>544</a> <span class="comment">// Safety: `ChildStderr` is guaranteed to be a valid file descriptor.
<a href=#545 id=545 data-nosnippet>545</a> </span><span class="kw">unsafe </span>{ Receiver::from_raw_fd(stderr.into_raw_fd()) }
<a href=#546 id=546 data-nosnippet>546</a> }
<a href=#547 id=547 data-nosnippet>547</a>}
<a href=#548 id=548 data-nosnippet>548</a>
<a href=#549 id=549 data-nosnippet>549</a><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>Receiver {
<a href=#550 id=550 data-nosnippet>550</a> <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -&gt; RawFd {
<a href=#551 id=551 data-nosnippet>551</a> <span class="self">self</span>.inner.into_inner().into_raw_fd()
<a href=#552 id=552 data-nosnippet>552</a> }
<a href=#553 id=553 data-nosnippet>553</a>}
<a href=#554 id=554 data-nosnippet>554</a>
<a href=#555 id=555 data-nosnippet>555</a><span class="kw">impl </span>AsRawFd <span class="kw">for </span>Receiver {
<a href=#556 id=556 data-nosnippet>556</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#557 id=557 data-nosnippet>557</a> <span class="self">self</span>.inner.as_raw_fd()
<a href=#558 id=558 data-nosnippet>558</a> }
<a href=#559 id=559 data-nosnippet>559</a>}
<a href=#560 id=560 data-nosnippet>560</a>
<a href=#561 id=561 data-nosnippet>561</a><span class="kw">impl </span>FromRawFd <span class="kw">for </span>Receiver {
<a href=#562 id=562 data-nosnippet>562</a> <span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -&gt; Receiver {
<a href=#563 id=563 data-nosnippet>563</a> Receiver {
<a href=#564 id=564 data-nosnippet>564</a> inner: IoSource::new(File::from_raw_fd(fd)),
<a href=#565 id=565 data-nosnippet>565</a> }
<a href=#566 id=566 data-nosnippet>566</a> }
<a href=#567 id=567 data-nosnippet>567</a>}
<a href=#568 id=568 data-nosnippet>568</a>
<a href=#569 id=569 data-nosnippet>569</a><span class="kw">impl </span>From&lt;Receiver&gt; <span class="kw">for </span>OwnedFd {
<a href=#570 id=570 data-nosnippet>570</a> <span class="kw">fn </span>from(receiver: Receiver) -&gt; <span class="self">Self </span>{
<a href=#571 id=571 data-nosnippet>571</a> receiver.inner.into_inner().into()
<a href=#572 id=572 data-nosnippet>572</a> }
<a href=#573 id=573 data-nosnippet>573</a>}
<a href=#574 id=574 data-nosnippet>574</a>
<a href=#575 id=575 data-nosnippet>575</a><span class="kw">impl </span>AsFd <span class="kw">for </span>Receiver {
<a href=#576 id=576 data-nosnippet>576</a> <span class="kw">fn </span>as_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BorrowedFd&lt;<span class="lifetime">'_</span>&gt; {
<a href=#577 id=577 data-nosnippet>577</a> <span class="self">self</span>.inner.as_fd()
<a href=#578 id=578 data-nosnippet>578</a> }
<a href=#579 id=579 data-nosnippet>579</a>}
<a href=#580 id=580 data-nosnippet>580</a>
<a href=#581 id=581 data-nosnippet>581</a><span class="kw">impl </span>From&lt;OwnedFd&gt; <span class="kw">for </span>Receiver {
<a href=#582 id=582 data-nosnippet>582</a> <span class="kw">fn </span>from(fd: OwnedFd) -&gt; <span class="self">Self </span>{
<a href=#583 id=583 data-nosnippet>583</a> Receiver {
<a href=#584 id=584 data-nosnippet>584</a> inner: IoSource::new(File::from(fd)),
<a href=#585 id=585 data-nosnippet>585</a> }
<a href=#586 id=586 data-nosnippet>586</a> }
<a href=#587 id=587 data-nosnippet>587</a>}
<a href=#588 id=588 data-nosnippet>588</a>
<a href=#589 id=589 data-nosnippet>589</a><span class="attr">#[cfg(not(any(target_os = <span class="string">"aix"</span>, target_os = <span class="string">"illumos"</span>, target_os = <span class="string">"solaris"</span>, target_os = <span class="string">"vita"</span>)))]
<a href=#590 id=590 data-nosnippet>590</a></span><span class="kw">fn </span>set_nonblocking(fd: RawFd, nonblocking: bool) -&gt; io::Result&lt;()&gt; {
<a href=#591 id=591 data-nosnippet>591</a> <span class="kw">let </span>value = nonblocking <span class="kw">as </span>libc::c_int;
<a href=#592 id=592 data-nosnippet>592</a> <span class="kw">if unsafe </span>{ libc::ioctl(fd, libc::FIONBIO, <span class="kw-2">&amp;</span>value) } == -<span class="number">1 </span>{
<a href=#593 id=593 data-nosnippet>593</a> <span class="prelude-val">Err</span>(io::Error::last_os_error())
<a href=#594 id=594 data-nosnippet>594</a> } <span class="kw">else </span>{
<a href=#595 id=595 data-nosnippet>595</a> <span class="prelude-val">Ok</span>(())
<a href=#596 id=596 data-nosnippet>596</a> }
<a href=#597 id=597 data-nosnippet>597</a>}
<a href=#598 id=598 data-nosnippet>598</a>
<a href=#599 id=599 data-nosnippet>599</a><span class="attr">#[cfg(any(target_os = <span class="string">"aix"</span>, target_os = <span class="string">"illumos"</span>, target_os = <span class="string">"solaris"</span>, target_os = <span class="string">"vita"</span>))]
<a href=#600 id=600 data-nosnippet>600</a></span><span class="kw">fn </span>set_nonblocking(fd: RawFd, nonblocking: bool) -&gt; io::Result&lt;()&gt; {
<a href=#601 id=601 data-nosnippet>601</a> <span class="kw">let </span>flags = <span class="kw">unsafe </span>{ libc::fcntl(fd, libc::F_GETFL) };
<a href=#602 id=602 data-nosnippet>602</a> <span class="kw">if </span>flags &lt; <span class="number">0 </span>{
<a href=#603 id=603 data-nosnippet>603</a> <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::last_os_error());
<a href=#604 id=604 data-nosnippet>604</a> }
<a href=#605 id=605 data-nosnippet>605</a>
<a href=#606 id=606 data-nosnippet>606</a> <span class="kw">let </span>nflags = <span class="kw">if </span>nonblocking {
<a href=#607 id=607 data-nosnippet>607</a> flags | libc::O_NONBLOCK
<a href=#608 id=608 data-nosnippet>608</a> } <span class="kw">else </span>{
<a href=#609 id=609 data-nosnippet>609</a> flags &amp; !libc::O_NONBLOCK
<a href=#610 id=610 data-nosnippet>610</a> };
<a href=#611 id=611 data-nosnippet>611</a>
<a href=#612 id=612 data-nosnippet>612</a> <span class="kw">if </span><span class="macro">flags !</span>= nflags {
<a href=#613 id=613 data-nosnippet>613</a> <span class="kw">if unsafe </span>{ libc::fcntl(fd, libc::F_SETFL, nflags) } &lt; <span class="number">0 </span>{
<a href=#614 id=614 data-nosnippet>614</a> <span class="kw">return </span><span class="prelude-val">Err</span>(io::Error::last_os_error());
<a href=#615 id=615 data-nosnippet>615</a> }
<a href=#616 id=616 data-nosnippet>616</a> }
<a href=#617 id=617 data-nosnippet>617</a>
<a href=#618 id=618 data-nosnippet>618</a> <span class="prelude-val">Ok</span>(())
<a href=#619 id=619 data-nosnippet>619</a>}
<a href=#620 id=620 data-nosnippet>620</a>} <span class="comment">// `cfg_os_ext!`.
</span></code></pre></div></section></main></body></html>
@@ -0,0 +1,238 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/selector/epoll.rs`."><title>epoll.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/selector/</div>epoll.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::io;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::os::fd::{AsRawFd, FromRawFd, OwnedFd, RawFd};
<a href=#3 id=3 data-nosnippet>3</a><span class="attr">#[cfg(debug_assertions)]
<a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering};
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::time::Duration;
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>libc::{EPOLLET, EPOLLIN, EPOLLOUT, EPOLLPRI, EPOLLRDHUP};
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">use crate</span>::{Interest, Token};
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="macro">cfg_io_source!</span> {
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">use </span>std::ptr;
<a href=#13 id=13 data-nosnippet>13</a>}
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a><span class="doccomment">/// Unique id for use as `SelectorId`.
<a href=#16 id=16 data-nosnippet>16</a></span><span class="attr">#[cfg(debug_assertions)]
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">static </span>NEXT_ID: AtomicUsize = AtomicUsize::new(<span class="number">1</span>);
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="attr">#[derive(Debug)]
<a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">pub struct </span>Selector {
<a href=#21 id=21 data-nosnippet>21</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#22 id=22 data-nosnippet>22</a> </span>id: usize,
<a href=#23 id=23 data-nosnippet>23</a> ep: OwnedFd,
<a href=#24 id=24 data-nosnippet>24</a>}
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">impl </span>Selector {
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">pub fn </span>new() -&gt; io::Result&lt;Selector&gt; {
<a href=#28 id=28 data-nosnippet>28</a> <span class="comment">// SAFETY: `epoll_create1(2)` ensures the fd is valid.
<a href=#29 id=29 data-nosnippet>29</a> </span><span class="kw">let </span>ep = <span class="kw">unsafe </span>{ OwnedFd::from_raw_fd(<span class="macro">syscall!</span>(epoll_create1(libc::EPOLL_CLOEXEC))<span class="question-mark">?</span>) };
<a href=#30 id=30 data-nosnippet>30</a> <span class="prelude-val">Ok</span>(Selector {
<a href=#31 id=31 data-nosnippet>31</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#32 id=32 data-nosnippet>32</a> </span>id: NEXT_ID.fetch_add(<span class="number">1</span>, Ordering::Relaxed),
<a href=#33 id=33 data-nosnippet>33</a> ep,
<a href=#34 id=34 data-nosnippet>34</a> })
<a href=#35 id=35 data-nosnippet>35</a> }
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">pub fn </span>try_clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;Selector&gt; {
<a href=#38 id=38 data-nosnippet>38</a> <span class="self">self</span>.ep.try_clone().map(|ep| Selector {
<a href=#39 id=39 data-nosnippet>39</a> <span class="comment">// It's the same selector, so we use the same id.
<a href=#40 id=40 data-nosnippet>40</a> </span><span class="attr">#[cfg(debug_assertions)]
<a href=#41 id=41 data-nosnippet>41</a> </span>id: <span class="self">self</span>.id,
<a href=#42 id=42 data-nosnippet>42</a> ep,
<a href=#43 id=43 data-nosnippet>43</a> })
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">pub fn </span>select(<span class="kw-2">&amp;</span><span class="self">self</span>, events: <span class="kw-2">&amp;mut </span>Events, timeout: <span class="prelude-ty">Option</span>&lt;Duration&gt;) -&gt; io::Result&lt;()&gt; {
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>timeout = timeout
<a href=#48 id=48 data-nosnippet>48</a> .map(|to| {
<a href=#49 id=49 data-nosnippet>49</a> <span class="comment">// `Duration::as_millis` truncates, so round up. This avoids
<a href=#50 id=50 data-nosnippet>50</a> // turning sub-millisecond timeouts into a zero timeout, unless
<a href=#51 id=51 data-nosnippet>51</a> // the caller explicitly requests that by specifying a zero
<a href=#52 id=52 data-nosnippet>52</a> // timeout.
<a href=#53 id=53 data-nosnippet>53</a> </span>to.checked_add(Duration::from_nanos(<span class="number">999_999</span>))
<a href=#54 id=54 data-nosnippet>54</a> .unwrap_or(to)
<a href=#55 id=55 data-nosnippet>55</a> .as_millis() <span class="kw">as </span>libc::c_int
<a href=#56 id=56 data-nosnippet>56</a> })
<a href=#57 id=57 data-nosnippet>57</a> .unwrap_or(-<span class="number">1</span>);
<a href=#58 id=58 data-nosnippet>58</a>
<a href=#59 id=59 data-nosnippet>59</a> events.clear();
<a href=#60 id=60 data-nosnippet>60</a> <span class="macro">syscall!</span>(epoll_wait(
<a href=#61 id=61 data-nosnippet>61</a> <span class="self">self</span>.ep.as_raw_fd(),
<a href=#62 id=62 data-nosnippet>62</a> events.as_mut_ptr(),
<a href=#63 id=63 data-nosnippet>63</a> events.capacity() <span class="kw">as </span>i32,
<a href=#64 id=64 data-nosnippet>64</a> timeout,
<a href=#65 id=65 data-nosnippet>65</a> ))
<a href=#66 id=66 data-nosnippet>66</a> .map(|n_events| {
<a href=#67 id=67 data-nosnippet>67</a> <span class="comment">// This is safe because `epoll_wait` ensures that `n_events` are
<a href=#68 id=68 data-nosnippet>68</a> // assigned.
<a href=#69 id=69 data-nosnippet>69</a> </span><span class="kw">unsafe </span>{ events.set_len(n_events <span class="kw">as </span>usize) };
<a href=#70 id=70 data-nosnippet>70</a> })
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">pub fn </span>register(<span class="kw-2">&amp;</span><span class="self">self</span>, fd: RawFd, token: Token, interests: Interest) -&gt; io::Result&lt;()&gt; {
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">let </span><span class="kw-2">mut </span>event = libc::epoll_event {
<a href=#75 id=75 data-nosnippet>75</a> events: interests_to_epoll(interests),
<a href=#76 id=76 data-nosnippet>76</a> u64: usize::from(token) <span class="kw">as </span>u64,
<a href=#77 id=77 data-nosnippet>77</a> <span class="attr">#[cfg(target_os = <span class="string">"redox"</span>)]
<a href=#78 id=78 data-nosnippet>78</a> </span>_pad: <span class="number">0</span>,
<a href=#79 id=79 data-nosnippet>79</a> };
<a href=#80 id=80 data-nosnippet>80</a>
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">let </span>ep = <span class="self">self</span>.ep.as_raw_fd();
<a href=#82 id=82 data-nosnippet>82</a> <span class="macro">syscall!</span>(epoll_ctl(ep, libc::EPOLL_CTL_ADD, fd, <span class="kw-2">&amp;mut </span>event)).map(|<span class="kw">_</span>| ())
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="macro">cfg_any_os_ext!</span> {
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">pub fn </span>reregister(<span class="kw-2">&amp;</span><span class="self">self</span>, fd: RawFd, token: Token, interests: Interest) -&gt; io::Result&lt;()&gt; {
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">let </span><span class="kw-2">mut </span>event = libc::epoll_event {
<a href=#88 id=88 data-nosnippet>88</a> events: interests_to_epoll(interests),
<a href=#89 id=89 data-nosnippet>89</a> u64: usize::from(token) <span class="kw">as </span>u64,
<a href=#90 id=90 data-nosnippet>90</a> <span class="attr">#[cfg(target_os = <span class="string">"redox"</span>)]
<a href=#91 id=91 data-nosnippet>91</a> </span>_pad: <span class="number">0</span>,
<a href=#92 id=92 data-nosnippet>92</a> };
<a href=#93 id=93 data-nosnippet>93</a>
<a href=#94 id=94 data-nosnippet>94</a> <span class="kw">let </span>ep = <span class="self">self</span>.ep.as_raw_fd();
<a href=#95 id=95 data-nosnippet>95</a> <span class="macro">syscall!</span>(epoll_ctl(ep, libc::EPOLL_CTL_MOD, fd, <span class="kw-2">&amp;mut </span>event)).map(|<span class="kw">_</span>| ())
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a>
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">pub fn </span>deregister(<span class="kw-2">&amp;</span><span class="self">self</span>, fd: RawFd) -&gt; io::Result&lt;()&gt; {
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">let </span>ep = <span class="self">self</span>.ep.as_raw_fd();
<a href=#100 id=100 data-nosnippet>100</a> <span class="macro">syscall!</span>(epoll_ctl(ep, libc::EPOLL_CTL_DEL, fd, ptr::null_mut())).map(|<span class="kw">_</span>| ())
<a href=#101 id=101 data-nosnippet>101</a> }
<a href=#102 id=102 data-nosnippet>102</a> }
<a href=#103 id=103 data-nosnippet>103</a>}
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a><span class="macro">cfg_io_source!</span> {
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">impl </span>Selector {
<a href=#107 id=107 data-nosnippet>107</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#108 id=108 data-nosnippet>108</a> </span><span class="kw">pub fn </span>id(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<a href=#109 id=109 data-nosnippet>109</a> <span class="self">self</span>.id
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a> }
<a href=#112 id=112 data-nosnippet>112</a>}
<a href=#113 id=113 data-nosnippet>113</a>
<a href=#114 id=114 data-nosnippet>114</a><span class="kw">impl </span>AsRawFd <span class="kw">for </span>Selector {
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#116 id=116 data-nosnippet>116</a> <span class="self">self</span>.ep.as_raw_fd()
<a href=#117 id=117 data-nosnippet>117</a> }
<a href=#118 id=118 data-nosnippet>118</a>}
<a href=#119 id=119 data-nosnippet>119</a>
<a href=#120 id=120 data-nosnippet>120</a><span class="kw">fn </span>interests_to_epoll(interests: Interest) -&gt; u32 {
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">let </span><span class="kw-2">mut </span>kind = EPOLLET;
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">if </span>interests.is_readable() {
<a href=#124 id=124 data-nosnippet>124</a> kind = kind | EPOLLIN | EPOLLRDHUP;
<a href=#125 id=125 data-nosnippet>125</a> }
<a href=#126 id=126 data-nosnippet>126</a>
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">if </span>interests.is_writable() {
<a href=#128 id=128 data-nosnippet>128</a> kind |= EPOLLOUT;
<a href=#129 id=129 data-nosnippet>129</a> }
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">if </span>interests.is_priority() {
<a href=#132 id=132 data-nosnippet>132</a> kind |= EPOLLPRI;
<a href=#133 id=133 data-nosnippet>133</a> }
<a href=#134 id=134 data-nosnippet>134</a>
<a href=#135 id=135 data-nosnippet>135</a> kind <span class="kw">as </span>u32
<a href=#136 id=136 data-nosnippet>136</a>}
<a href=#137 id=137 data-nosnippet>137</a>
<a href=#138 id=138 data-nosnippet>138</a><span class="kw">pub type </span>Event = libc::epoll_event;
<a href=#139 id=139 data-nosnippet>139</a><span class="kw">pub type </span>Events = Vec&lt;Event&gt;;
<a href=#140 id=140 data-nosnippet>140</a>
<a href=#141 id=141 data-nosnippet>141</a><span class="kw">pub mod </span>event {
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">use </span>std::fmt;
<a href=#143 id=143 data-nosnippet>143</a>
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">use </span><span class="kw">crate</span>::sys::Event;
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">use </span><span class="kw">crate</span>::Token;
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">pub fn </span>token(event: <span class="kw-2">&amp;</span>Event) -&gt; Token {
<a href=#148 id=148 data-nosnippet>148</a> Token(event.u64 <span class="kw">as </span>usize)
<a href=#149 id=149 data-nosnippet>149</a> }
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">pub fn </span>is_readable(event: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#152 id=152 data-nosnippet>152</a> (event.events <span class="kw">as </span>libc::c_int &amp; libc::EPOLLIN) != <span class="number">0
<a href=#153 id=153 data-nosnippet>153</a> </span>|| (event.events <span class="kw">as </span>libc::c_int &amp; libc::EPOLLPRI) != <span class="number">0
<a href=#154 id=154 data-nosnippet>154</a> </span>}
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">pub fn </span>is_writable(event: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#157 id=157 data-nosnippet>157</a> (event.events <span class="kw">as </span>libc::c_int &amp; libc::EPOLLOUT) != <span class="number">0
<a href=#158 id=158 data-nosnippet>158</a> </span>}
<a href=#159 id=159 data-nosnippet>159</a>
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">pub fn </span>is_error(event: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#161 id=161 data-nosnippet>161</a> (event.events <span class="kw">as </span>libc::c_int &amp; libc::EPOLLERR) != <span class="number">0
<a href=#162 id=162 data-nosnippet>162</a> </span>}
<a href=#163 id=163 data-nosnippet>163</a>
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">pub fn </span>is_read_closed(event: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#165 id=165 data-nosnippet>165</a> <span class="comment">// Both halves of the socket have closed
<a href=#166 id=166 data-nosnippet>166</a> </span>event.events <span class="kw">as </span>libc::c_int &amp; <span class="macro">libc::EPOLLHUP !</span>= <span class="number">0
<a href=#167 id=167 data-nosnippet>167</a> </span><span class="comment">// Socket has received FIN or called shutdown(SHUT_RD)
<a href=#168 id=168 data-nosnippet>168</a> </span>|| (event.events <span class="kw">as </span>libc::c_int &amp; <span class="macro">libc::EPOLLIN !</span>= <span class="number">0
<a href=#169 id=169 data-nosnippet>169</a> </span>&amp;&amp; event.events <span class="kw">as </span>libc::c_int &amp; <span class="macro">libc::EPOLLRDHUP !</span>= <span class="number">0</span>)
<a href=#170 id=170 data-nosnippet>170</a> }
<a href=#171 id=171 data-nosnippet>171</a>
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">pub fn </span>is_write_closed(event: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#173 id=173 data-nosnippet>173</a> <span class="comment">// Both halves of the socket have closed
<a href=#174 id=174 data-nosnippet>174</a> </span>event.events <span class="kw">as </span>libc::c_int &amp; <span class="macro">libc::EPOLLHUP !</span>= <span class="number">0
<a href=#175 id=175 data-nosnippet>175</a> </span><span class="comment">// Unix pipe write end has closed
<a href=#176 id=176 data-nosnippet>176</a> </span>|| (event.events <span class="kw">as </span>libc::c_int &amp; <span class="macro">libc::EPOLLOUT !</span>= <span class="number">0
<a href=#177 id=177 data-nosnippet>177</a> </span>&amp;&amp; event.events <span class="kw">as </span>libc::c_int &amp; <span class="macro">libc::EPOLLERR !</span>= <span class="number">0</span>)
<a href=#178 id=178 data-nosnippet>178</a> <span class="comment">// The other side (read end) of a Unix pipe has closed.
<a href=#179 id=179 data-nosnippet>179</a> </span>|| event.events <span class="kw">as </span>libc::c_int == libc::EPOLLERR
<a href=#180 id=180 data-nosnippet>180</a> }
<a href=#181 id=181 data-nosnippet>181</a>
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw">pub fn </span>is_priority(event: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#183 id=183 data-nosnippet>183</a> (event.events <span class="kw">as </span>libc::c_int &amp; libc::EPOLLPRI) != <span class="number">0
<a href=#184 id=184 data-nosnippet>184</a> </span>}
<a href=#185 id=185 data-nosnippet>185</a>
<a href=#186 id=186 data-nosnippet>186</a> <span class="kw">pub fn </span>is_aio(<span class="kw">_</span>: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#187 id=187 data-nosnippet>187</a> <span class="comment">// Not supported in the kernel, only in libc.
<a href=#188 id=188 data-nosnippet>188</a> </span><span class="bool-val">false
<a href=#189 id=189 data-nosnippet>189</a> </span>}
<a href=#190 id=190 data-nosnippet>190</a>
<a href=#191 id=191 data-nosnippet>191</a> <span class="kw">pub fn </span>is_lio(<span class="kw">_</span>: <span class="kw-2">&amp;</span>Event) -&gt; bool {
<a href=#192 id=192 data-nosnippet>192</a> <span class="comment">// Not supported.
<a href=#193 id=193 data-nosnippet>193</a> </span><span class="bool-val">false
<a href=#194 id=194 data-nosnippet>194</a> </span>}
<a href=#195 id=195 data-nosnippet>195</a>
<a href=#196 id=196 data-nosnippet>196</a> <span class="kw">pub fn </span>debug_details(f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;, event: <span class="kw-2">&amp;</span>Event) -&gt; fmt::Result {
<a href=#197 id=197 data-nosnippet>197</a> <span class="attr">#[allow(clippy::trivially_copy_pass_by_ref)]
<a href=#198 id=198 data-nosnippet>198</a> </span><span class="kw">fn </span>check_events(got: <span class="kw-2">&amp;</span>u32, want: <span class="kw-2">&amp;</span>libc::c_int) -&gt; bool {
<a href=#199 id=199 data-nosnippet>199</a> (<span class="kw-2">*</span>got <span class="kw">as </span>libc::c_int &amp; want) != <span class="number">0
<a href=#200 id=200 data-nosnippet>200</a> </span>}
<a href=#201 id=201 data-nosnippet>201</a> <span class="macro">debug_detail!</span>(
<a href=#202 id=202 data-nosnippet>202</a> EventsDetails(u32),
<a href=#203 id=203 data-nosnippet>203</a> check_events,
<a href=#204 id=204 data-nosnippet>204</a> libc::EPOLLIN,
<a href=#205 id=205 data-nosnippet>205</a> libc::EPOLLPRI,
<a href=#206 id=206 data-nosnippet>206</a> libc::EPOLLOUT,
<a href=#207 id=207 data-nosnippet>207</a> libc::EPOLLRDNORM,
<a href=#208 id=208 data-nosnippet>208</a> libc::EPOLLRDBAND,
<a href=#209 id=209 data-nosnippet>209</a> libc::EPOLLWRNORM,
<a href=#210 id=210 data-nosnippet>210</a> libc::EPOLLWRBAND,
<a href=#211 id=211 data-nosnippet>211</a> libc::EPOLLMSG,
<a href=#212 id=212 data-nosnippet>212</a> libc::EPOLLERR,
<a href=#213 id=213 data-nosnippet>213</a> libc::EPOLLHUP,
<a href=#214 id=214 data-nosnippet>214</a> libc::EPOLLET,
<a href=#215 id=215 data-nosnippet>215</a> libc::EPOLLRDHUP,
<a href=#216 id=216 data-nosnippet>216</a> libc::EPOLLONESHOT,
<a href=#217 id=217 data-nosnippet>217</a> libc::EPOLLEXCLUSIVE,
<a href=#218 id=218 data-nosnippet>218</a> libc::EPOLLWAKEUP,
<a href=#219 id=219 data-nosnippet>219</a> libc::EPOLL_CLOEXEC,
<a href=#220 id=220 data-nosnippet>220</a> );
<a href=#221 id=221 data-nosnippet>221</a>
<a href=#222 id=222 data-nosnippet>222</a> <span class="comment">// Can't reference fields in packed structures.
<a href=#223 id=223 data-nosnippet>223</a> </span><span class="kw">let </span>e_u64 = event.u64;
<a href=#224 id=224 data-nosnippet>224</a> f.debug_struct(<span class="string">"epoll_event"</span>)
<a href=#225 id=225 data-nosnippet>225</a> .field(<span class="string">"events"</span>, <span class="kw-2">&amp;</span>EventsDetails(event.events))
<a href=#226 id=226 data-nosnippet>226</a> .field(<span class="string">"u64"</span>, <span class="kw-2">&amp;</span>e_u64)
<a href=#227 id=227 data-nosnippet>227</a> .finish()
<a href=#228 id=228 data-nosnippet>228</a> }
<a href=#229 id=229 data-nosnippet>229</a>}
<a href=#230 id=230 data-nosnippet>230</a>
<a href=#231 id=231 data-nosnippet>231</a><span class="comment">// No special requirement from the implementation around waking.
<a href=#232 id=232 data-nosnippet>232</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::sys::unix::waker::Waker;
<a href=#233 id=233 data-nosnippet>233</a>
<a href=#234 id=234 data-nosnippet>234</a><span class="macro">cfg_io_source!</span> {
<a href=#235 id=235 data-nosnippet>235</a> <span class="kw">mod </span>stateless_io_source;
<a href=#236 id=236 data-nosnippet>236</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>stateless_io_source::IoSourceState;
<a href=#237 id=237 data-nosnippet>237</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,51 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/selector/stateless_io_source.rs`."><title>stateless_io_source.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/selector/</div>stateless_io_source.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Both `kqueue(2)` and `epoll(2)` don't need to hold any user space state.
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>std::io;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::os::fd::RawFd;
<a href=#5 id=5 data-nosnippet>5</a>
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use crate</span>::{Interest, Registry, Token};
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>IoSourceState;
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">impl </span>IoSourceState {
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new() -&gt; IoSourceState {
<a href=#12 id=12 data-nosnippet>12</a> IoSourceState
<a href=#13 id=13 data-nosnippet>13</a> }
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>do_io&lt;T, F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, f: F, io: <span class="kw-2">&amp;</span>T) -&gt; io::Result&lt;R&gt;
<a href=#16 id=16 data-nosnippet>16</a> <span class="kw">where
<a href=#17 id=17 data-nosnippet>17</a> </span>F: FnOnce(<span class="kw-2">&amp;</span>T) -&gt; io::Result&lt;R&gt;,
<a href=#18 id=18 data-nosnippet>18</a> {
<a href=#19 id=19 data-nosnippet>19</a> <span class="comment">// We don't hold state, so we can just call the function and
<a href=#20 id=20 data-nosnippet>20</a> // return.
<a href=#21 id=21 data-nosnippet>21</a> </span>f(io)
<a href=#22 id=22 data-nosnippet>22</a> }
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>register(
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#26 id=26 data-nosnippet>26</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#27 id=27 data-nosnippet>27</a> token: Token,
<a href=#28 id=28 data-nosnippet>28</a> interests: Interest,
<a href=#29 id=29 data-nosnippet>29</a> fd: RawFd,
<a href=#30 id=30 data-nosnippet>30</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#31 id=31 data-nosnippet>31</a> <span class="comment">// Pass through, we don't have any state.
<a href=#32 id=32 data-nosnippet>32</a> </span>registry.selector().register(fd, token, interests)
<a href=#33 id=33 data-nosnippet>33</a> }
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>reregister(
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#37 id=37 data-nosnippet>37</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#38 id=38 data-nosnippet>38</a> token: Token,
<a href=#39 id=39 data-nosnippet>39</a> interests: Interest,
<a href=#40 id=40 data-nosnippet>40</a> fd: RawFd,
<a href=#41 id=41 data-nosnippet>41</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#42 id=42 data-nosnippet>42</a> <span class="comment">// Pass through, we don't have any state.
<a href=#43 id=43 data-nosnippet>43</a> </span>registry.selector().reregister(fd, token, interests)
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry, fd: RawFd) -&gt; io::Result&lt;()&gt; {
<a href=#47 id=47 data-nosnippet>47</a> <span class="comment">// Pass through, we don't have any state.
<a href=#48 id=48 data-nosnippet>48</a> </span>registry.selector().deregister(fd)
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,122 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/sourcefd.rs`."><title>sourcefd.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/</div>sourcefd.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::io;
<a href=#2 id=2 data-nosnippet>2</a><span class="attr">#[cfg(not(target_os = <span class="string">"hermit"</span>))]
<a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>std::os::fd::RawFd;
<a href=#4 id=4 data-nosnippet>4</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#5 id=5 data-nosnippet>5</a>// can use `std::os::fd` and be merged with the above.
<a href=#6 id=6 data-nosnippet>6</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">use </span>std::os::hermit::io::RawFd;
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">use crate</span>::{event, Interest, Registry, Token};
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="doccomment">/// Adapter for [`RawFd`] providing an [`event::Source`] implementation.
<a href=#12 id=12 data-nosnippet>12</a>///
<a href=#13 id=13 data-nosnippet>13</a>/// `SourceFd` enables registering any type with an FD with [`Poll`].
<a href=#14 id=14 data-nosnippet>14</a>///
<a href=#15 id=15 data-nosnippet>15</a>/// While only implementations for TCP and UDP are provided, Mio supports
<a href=#16 id=16 data-nosnippet>16</a>/// registering any FD that can be registered with the underlying OS selector.
<a href=#17 id=17 data-nosnippet>17</a>/// `SourceFd` provides the necessary bridge.
<a href=#18 id=18 data-nosnippet>18</a>///
<a href=#19 id=19 data-nosnippet>19</a>/// Note that `SourceFd` takes a `&amp;RawFd`. This is because `SourceFd` **does
<a href=#20 id=20 data-nosnippet>20</a>/// not** take ownership of the FD. Specifically, it will not manage any
<a href=#21 id=21 data-nosnippet>21</a>/// lifecycle related operations, such as closing the FD on drop. It is expected
<a href=#22 id=22 data-nosnippet>22</a>/// that the `SourceFd` is constructed right before a call to
<a href=#23 id=23 data-nosnippet>23</a>/// [`Registry::register`]. See the examples for more detail.
<a href=#24 id=24 data-nosnippet>24</a>///
<a href=#25 id=25 data-nosnippet>25</a>/// [`event::Source`]: ../event/trait.Source.html
<a href=#26 id=26 data-nosnippet>26</a>/// [`Poll`]: ../struct.Poll.html
<a href=#27 id=27 data-nosnippet>27</a>/// [`Registry::register`]: ../struct.Registry.html#method.register
<a href=#28 id=28 data-nosnippet>28</a>///
<a href=#29 id=29 data-nosnippet>29</a>/// # Examples
<a href=#30 id=30 data-nosnippet>30</a>///
<a href=#31 id=31 data-nosnippet>31</a>/// Basic usage.
<a href=#32 id=32 data-nosnippet>32</a>///
<a href=#33 id=33 data-nosnippet>33</a></span><span class="attr">#[cfg_attr(
<a href=#34 id=34 data-nosnippet>34</a> all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>, feature = <span class="string">"os-ext"</span>),
<a href=#35 id=35 data-nosnippet>35</a> doc = <span class="string">"```"
<a href=#36 id=36 data-nosnippet>36</a></span>)]
<a href=#37 id=37 data-nosnippet>37</a>#[cfg_attr(
<a href=#38 id=38 data-nosnippet>38</a> not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>, feature = <span class="string">"os-ext"</span>)),
<a href=#39 id=39 data-nosnippet>39</a> doc = <span class="string">"```ignore"
<a href=#40 id=40 data-nosnippet>40</a></span>)]
<a href=#41 id=41 data-nosnippet>41</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#42 id=42 data-nosnippet>42</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#43 id=43 data-nosnippet>43</a>/// use mio::{Interest, Poll, Token};
<a href=#44 id=44 data-nosnippet>44</a>/// use mio::unix::SourceFd;
<a href=#45 id=45 data-nosnippet>45</a>///
<a href=#46 id=46 data-nosnippet>46</a>/// use std::os::fd::AsRawFd;
<a href=#47 id=47 data-nosnippet>47</a>/// use std::net::TcpListener;
<a href=#48 id=48 data-nosnippet>48</a>///
<a href=#49 id=49 data-nosnippet>49</a>/// // Bind a std listener
<a href=#50 id=50 data-nosnippet>50</a>/// let listener = TcpListener::bind("127.0.0.1:0")?;
<a href=#51 id=51 data-nosnippet>51</a>///
<a href=#52 id=52 data-nosnippet>52</a>/// let poll = Poll::new()?;
<a href=#53 id=53 data-nosnippet>53</a>///
<a href=#54 id=54 data-nosnippet>54</a>/// // Register the listener
<a href=#55 id=55 data-nosnippet>55</a>/// poll.registry().register(
<a href=#56 id=56 data-nosnippet>56</a>/// &amp;mut SourceFd(&amp;listener.as_raw_fd()),
<a href=#57 id=57 data-nosnippet>57</a>/// Token(0),
<a href=#58 id=58 data-nosnippet>58</a>/// Interest::READABLE)?;
<a href=#59 id=59 data-nosnippet>59</a>/// # Ok(())
<a href=#60 id=60 data-nosnippet>60</a>/// # }
<a href=#61 id=61 data-nosnippet>61</a>/// ```
<a href=#62 id=62 data-nosnippet>62</a>///
<a href=#63 id=63 data-nosnippet>63</a>/// Implementing [`event::Source`] for a custom type backed by a [`RawFd`].
<a href=#64 id=64 data-nosnippet>64</a>///
<a href=#65 id=65 data-nosnippet>65</a></span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"os-ext"</span>), doc = <span class="string">"```"</span>)]
<a href=#66 id=66 data-nosnippet>66</a>#[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"os-ext"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#67 id=67 data-nosnippet>67</a></span><span class="doccomment">/// use mio::{event, Interest, Registry, Token};
<a href=#68 id=68 data-nosnippet>68</a>/// use mio::unix::SourceFd;
<a href=#69 id=69 data-nosnippet>69</a>///
<a href=#70 id=70 data-nosnippet>70</a>/// use std::os::fd::RawFd;
<a href=#71 id=71 data-nosnippet>71</a>/// use std::io;
<a href=#72 id=72 data-nosnippet>72</a>///
<a href=#73 id=73 data-nosnippet>73</a>/// # #[allow(dead_code)]
<a href=#74 id=74 data-nosnippet>74</a>/// pub struct MyIo {
<a href=#75 id=75 data-nosnippet>75</a>/// fd: RawFd,
<a href=#76 id=76 data-nosnippet>76</a>/// }
<a href=#77 id=77 data-nosnippet>77</a>///
<a href=#78 id=78 data-nosnippet>78</a>/// impl event::Source for MyIo {
<a href=#79 id=79 data-nosnippet>79</a>/// fn register(&amp;mut self, registry: &amp;Registry, token: Token, interests: Interest)
<a href=#80 id=80 data-nosnippet>80</a>/// -&gt; io::Result&lt;()&gt;
<a href=#81 id=81 data-nosnippet>81</a>/// {
<a href=#82 id=82 data-nosnippet>82</a>/// SourceFd(&amp;self.fd).register(registry, token, interests)
<a href=#83 id=83 data-nosnippet>83</a>/// }
<a href=#84 id=84 data-nosnippet>84</a>///
<a href=#85 id=85 data-nosnippet>85</a>/// fn reregister(&amp;mut self, registry: &amp;Registry, token: Token, interests: Interest)
<a href=#86 id=86 data-nosnippet>86</a>/// -&gt; io::Result&lt;()&gt;
<a href=#87 id=87 data-nosnippet>87</a>/// {
<a href=#88 id=88 data-nosnippet>88</a>/// SourceFd(&amp;self.fd).reregister(registry, token, interests)
<a href=#89 id=89 data-nosnippet>89</a>/// }
<a href=#90 id=90 data-nosnippet>90</a>///
<a href=#91 id=91 data-nosnippet>91</a>/// fn deregister(&amp;mut self, registry: &amp;Registry) -&gt; io::Result&lt;()&gt; {
<a href=#92 id=92 data-nosnippet>92</a>/// SourceFd(&amp;self.fd).deregister(registry)
<a href=#93 id=93 data-nosnippet>93</a>/// }
<a href=#94 id=94 data-nosnippet>94</a>/// }
<a href=#95 id=95 data-nosnippet>95</a>/// ```
<a href=#96 id=96 data-nosnippet>96</a></span><span class="attr">#[derive(Debug)]
<a href=#97 id=97 data-nosnippet>97</a></span><span class="kw">pub struct </span>SourceFd&lt;<span class="lifetime">'a</span>&gt;(<span class="kw">pub </span><span class="kw-2">&amp;</span><span class="lifetime">'a </span>RawFd);
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; event::Source <span class="kw">for </span>SourceFd&lt;<span class="lifetime">'a</span>&gt; {
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">fn </span>register(
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#102 id=102 data-nosnippet>102</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#103 id=103 data-nosnippet>103</a> token: Token,
<a href=#104 id=104 data-nosnippet>104</a> interests: Interest,
<a href=#105 id=105 data-nosnippet>105</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#106 id=106 data-nosnippet>106</a> registry.selector().register(<span class="kw-2">*</span><span class="self">self</span>.<span class="number">0</span>, token, interests)
<a href=#107 id=107 data-nosnippet>107</a> }
<a href=#108 id=108 data-nosnippet>108</a>
<a href=#109 id=109 data-nosnippet>109</a> <span class="kw">fn </span>reregister(
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw-2">&amp;mut </span><span class="self">self</span>,
<a href=#111 id=111 data-nosnippet>111</a> registry: <span class="kw-2">&amp;</span>Registry,
<a href=#112 id=112 data-nosnippet>112</a> token: Token,
<a href=#113 id=113 data-nosnippet>113</a> interests: Interest,
<a href=#114 id=114 data-nosnippet>114</a> ) -&gt; io::Result&lt;()&gt; {
<a href=#115 id=115 data-nosnippet>115</a> registry.selector().reregister(<span class="kw-2">*</span><span class="self">self</span>.<span class="number">0</span>, token, interests)
<a href=#116 id=116 data-nosnippet>116</a> }
<a href=#117 id=117 data-nosnippet>117</a>
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">fn </span>deregister(<span class="kw-2">&amp;mut </span><span class="self">self</span>, registry: <span class="kw-2">&amp;</span>Registry) -&gt; io::Result&lt;()&gt; {
<a href=#119 id=119 data-nosnippet>119</a> registry.selector().deregister(<span class="kw-2">*</span><span class="self">self</span>.<span class="number">0</span>)
<a href=#120 id=120 data-nosnippet>120</a> }
<a href=#121 id=121 data-nosnippet>121</a>}
</code></pre></div></section></main></body></html>
+136
View File
@@ -0,0 +1,136 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/tcp.rs`."><title>tcp.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/</div>tcp.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::io;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::mem::{size_of, MaybeUninit};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::net::{<span class="self">self</span>, SocketAddr};
<a href=#4 id=4 data-nosnippet>4</a><span class="attr">#[cfg(not(target_os = <span class="string">"hermit"</span>))]
<a href=#5 id=5 data-nosnippet>5</a></span><span class="kw">use </span>std::os::fd::{AsRawFd, FromRawFd};
<a href=#6 id=6 data-nosnippet>6</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#7 id=7 data-nosnippet>7</a>// can use `std::os::fd` and be merged with the above.
<a href=#8 id=8 data-nosnippet>8</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">use </span>std::os::hermit::io::{AsRawFd, FromRawFd};
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::net::{new_socket, socket_addr, to_socket_addr};
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_for_addr(address: SocketAddr) -&gt; io::Result&lt;libc::c_int&gt; {
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">let </span>domain = <span class="kw">match </span>address {
<a href=#15 id=15 data-nosnippet>15</a> SocketAddr::V4(<span class="kw">_</span>) =&gt; libc::AF_INET,
<a href=#16 id=16 data-nosnippet>16</a> SocketAddr::V6(<span class="kw">_</span>) =&gt; libc::AF_INET6,
<a href=#17 id=17 data-nosnippet>17</a> };
<a href=#18 id=18 data-nosnippet>18</a> new_socket(domain, libc::SOCK_STREAM)
<a href=#19 id=19 data-nosnippet>19</a>}
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>bind(socket: <span class="kw-2">&amp;</span>net::TcpListener, addr: SocketAddr) -&gt; io::Result&lt;()&gt; {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>(raw_addr, raw_addr_length) = socket_addr(<span class="kw-2">&amp;</span>addr);
<a href=#23 id=23 data-nosnippet>23</a> <span class="macro">syscall!</span>(bind(socket.as_raw_fd(), raw_addr.as_ptr(), raw_addr_length))<span class="question-mark">?</span>;
<a href=#24 id=24 data-nosnippet>24</a> <span class="prelude-val">Ok</span>(())
<a href=#25 id=25 data-nosnippet>25</a>}
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>connect(socket: <span class="kw-2">&amp;</span>net::TcpStream, addr: SocketAddr) -&gt; io::Result&lt;()&gt; {
<a href=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>(raw_addr, raw_addr_length) = socket_addr(<span class="kw-2">&amp;</span>addr);
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">match </span><span class="macro">syscall!</span>(connect(
<a href=#31 id=31 data-nosnippet>31</a> socket.as_raw_fd(),
<a href=#32 id=32 data-nosnippet>32</a> raw_addr.as_ptr(),
<a href=#33 id=33 data-nosnippet>33</a> raw_addr_length
<a href=#34 id=34 data-nosnippet>34</a> )) {
<a href=#35 id=35 data-nosnippet>35</a> <span class="prelude-val">Err</span>(err) <span class="kw">if </span>err.raw_os_error() != <span class="prelude-val">Some</span>(libc::EINPROGRESS) =&gt; <span class="prelude-val">Err</span>(err),
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">_ </span>=&gt; <span class="prelude-val">Ok</span>(()),
<a href=#37 id=37 data-nosnippet>37</a> }
<a href=#38 id=38 data-nosnippet>38</a>}
<a href=#39 id=39 data-nosnippet>39</a>
<a href=#40 id=40 data-nosnippet>40</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>listen(socket: <span class="kw-2">&amp;</span>net::TcpListener, backlog: i32) -&gt; io::Result&lt;()&gt; {
<a href=#41 id=41 data-nosnippet>41</a> <span class="macro">syscall!</span>(listen(socket.as_raw_fd(), backlog))<span class="question-mark">?</span>;
<a href=#42 id=42 data-nosnippet>42</a> <span class="prelude-val">Ok</span>(())
<a href=#43 id=43 data-nosnippet>43</a>}
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>set_reuseaddr(socket: <span class="kw-2">&amp;</span>net::TcpListener, reuseaddr: bool) -&gt; io::Result&lt;()&gt; {
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span>val: libc::c_int = i32::from(reuseaddr);
<a href=#47 id=47 data-nosnippet>47</a> <span class="macro">syscall!</span>(setsockopt(
<a href=#48 id=48 data-nosnippet>48</a> socket.as_raw_fd(),
<a href=#49 id=49 data-nosnippet>49</a> libc::SOL_SOCKET,
<a href=#50 id=50 data-nosnippet>50</a> libc::SO_REUSEADDR,
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw-2">&amp;</span>val <span class="kw">as </span><span class="kw-2">*const </span>libc::c_int <span class="kw">as </span><span class="kw-2">*const </span>libc::c_void,
<a href=#52 id=52 data-nosnippet>52</a> size_of::&lt;libc::c_int&gt;() <span class="kw">as </span>libc::socklen_t,
<a href=#53 id=53 data-nosnippet>53</a> ))<span class="question-mark">?</span>;
<a href=#54 id=54 data-nosnippet>54</a> <span class="prelude-val">Ok</span>(())
<a href=#55 id=55 data-nosnippet>55</a>}
<a href=#56 id=56 data-nosnippet>56</a>
<a href=#57 id=57 data-nosnippet>57</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>accept(listener: <span class="kw-2">&amp;</span>net::TcpListener) -&gt; io::Result&lt;(net::TcpStream, SocketAddr)&gt; {
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">let </span><span class="kw-2">mut </span>addr: MaybeUninit&lt;libc::sockaddr_storage&gt; = MaybeUninit::uninit();
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">let </span><span class="kw-2">mut </span>length = size_of::&lt;libc::sockaddr_storage&gt;() <span class="kw">as </span>libc::socklen_t;
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a> <span class="comment">// On platforms that support it we can use `accept4(2)` to set `NONBLOCK`
<a href=#62 id=62 data-nosnippet>62</a> // and `CLOEXEC` in the call to accept the connection.
<a href=#63 id=63 data-nosnippet>63</a> </span><span class="attr">#[cfg(any(
<a href=#64 id=64 data-nosnippet>64</a> <span class="comment">// Android x86's seccomp profile forbids calls to `accept4(2)`
<a href=#65 id=65 data-nosnippet>65</a> // See https://github.com/tokio-rs/mio/issues/1445 for details
<a href=#66 id=66 data-nosnippet>66</a> </span>all(not(target_arch=<span class="string">"x86"</span>), target_os = <span class="string">"android"</span>),
<a href=#67 id=67 data-nosnippet>67</a> target_os = <span class="string">"dragonfly"</span>,
<a href=#68 id=68 data-nosnippet>68</a> target_os = <span class="string">"freebsd"</span>,
<a href=#69 id=69 data-nosnippet>69</a> target_os = <span class="string">"fuchsia"</span>,
<a href=#70 id=70 data-nosnippet>70</a> target_os = <span class="string">"hurd"</span>,
<a href=#71 id=71 data-nosnippet>71</a> target_os = <span class="string">"illumos"</span>,
<a href=#72 id=72 data-nosnippet>72</a> target_os = <span class="string">"linux"</span>,
<a href=#73 id=73 data-nosnippet>73</a> target_os = <span class="string">"netbsd"</span>,
<a href=#74 id=74 data-nosnippet>74</a> target_os = <span class="string">"openbsd"</span>,
<a href=#75 id=75 data-nosnippet>75</a> target_os = <span class="string">"solaris"</span>,
<a href=#76 id=76 data-nosnippet>76</a> target_os = <span class="string">"cygwin"</span>,
<a href=#77 id=77 data-nosnippet>77</a> ))]
<a href=#78 id=78 data-nosnippet>78</a> </span><span class="kw">let </span>stream = {
<a href=#79 id=79 data-nosnippet>79</a> <span class="macro">syscall!</span>(accept4(
<a href=#80 id=80 data-nosnippet>80</a> listener.as_raw_fd(),
<a href=#81 id=81 data-nosnippet>81</a> addr.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>,
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw-2">&amp;mut </span>length,
<a href=#83 id=83 data-nosnippet>83</a> libc::SOCK_CLOEXEC | libc::SOCK_NONBLOCK,
<a href=#84 id=84 data-nosnippet>84</a> ))
<a href=#85 id=85 data-nosnippet>85</a> .map(|socket| <span class="kw">unsafe </span>{ net::TcpStream::from_raw_fd(socket) })
<a href=#86 id=86 data-nosnippet>86</a> }<span class="question-mark">?</span>;
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a> <span class="comment">// But not all platforms have the `accept4(2)` call. Luckily BSD (derived)
<a href=#89 id=89 data-nosnippet>89</a> // OSs inherit the non-blocking flag from the listener, so we just have to
<a href=#90 id=90 data-nosnippet>90</a> // set `CLOEXEC`.
<a href=#91 id=91 data-nosnippet>91</a> </span><span class="attr">#[cfg(any(
<a href=#92 id=92 data-nosnippet>92</a> target_os = <span class="string">"aix"</span>,
<a href=#93 id=93 data-nosnippet>93</a> target_os = <span class="string">"haiku"</span>,
<a href=#94 id=94 data-nosnippet>94</a> target_os = <span class="string">"ios"</span>,
<a href=#95 id=95 data-nosnippet>95</a> target_os = <span class="string">"macos"</span>,
<a href=#96 id=96 data-nosnippet>96</a> target_os = <span class="string">"redox"</span>,
<a href=#97 id=97 data-nosnippet>97</a> target_os = <span class="string">"tvos"</span>,
<a href=#98 id=98 data-nosnippet>98</a> target_os = <span class="string">"visionos"</span>,
<a href=#99 id=99 data-nosnippet>99</a> target_os = <span class="string">"watchos"</span>,
<a href=#100 id=100 data-nosnippet>100</a> target_os = <span class="string">"espidf"</span>,
<a href=#101 id=101 data-nosnippet>101</a> target_os = <span class="string">"vita"</span>,
<a href=#102 id=102 data-nosnippet>102</a> target_os = <span class="string">"hermit"</span>,
<a href=#103 id=103 data-nosnippet>103</a> target_os = <span class="string">"nto"</span>,
<a href=#104 id=104 data-nosnippet>104</a> all(target_arch = <span class="string">"x86"</span>, target_os = <span class="string">"android"</span>),
<a href=#105 id=105 data-nosnippet>105</a> ))]
<a href=#106 id=106 data-nosnippet>106</a> </span><span class="kw">let </span>stream = {
<a href=#107 id=107 data-nosnippet>107</a> <span class="macro">syscall!</span>(accept(
<a href=#108 id=108 data-nosnippet>108</a> listener.as_raw_fd(),
<a href=#109 id=109 data-nosnippet>109</a> addr.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>,
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw-2">&amp;mut </span>length
<a href=#111 id=111 data-nosnippet>111</a> ))
<a href=#112 id=112 data-nosnippet>112</a> .map(|socket| <span class="kw">unsafe </span>{ net::TcpStream::from_raw_fd(socket) })
<a href=#113 id=113 data-nosnippet>113</a> .and_then(|s| {
<a href=#114 id=114 data-nosnippet>114</a> <span class="attr">#[cfg(not(any(target_os = <span class="string">"espidf"</span>, target_os = <span class="string">"vita"</span>)))]
<a href=#115 id=115 data-nosnippet>115</a> </span><span class="macro">syscall!</span>(fcntl(s.as_raw_fd(), libc::F_SETFD, libc::FD_CLOEXEC))<span class="question-mark">?</span>;
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a> <span class="comment">// See https://github.com/tokio-rs/mio/issues/1450
<a href=#118 id=118 data-nosnippet>118</a> </span><span class="attr">#[cfg(any(
<a href=#119 id=119 data-nosnippet>119</a> all(target_arch = <span class="string">"x86"</span>, target_os = <span class="string">"android"</span>),
<a href=#120 id=120 data-nosnippet>120</a> target_os = <span class="string">"aix"</span>,
<a href=#121 id=121 data-nosnippet>121</a> target_os = <span class="string">"espidf"</span>,
<a href=#122 id=122 data-nosnippet>122</a> target_os = <span class="string">"vita"</span>,
<a href=#123 id=123 data-nosnippet>123</a> target_os = <span class="string">"hermit"</span>,
<a href=#124 id=124 data-nosnippet>124</a> target_os = <span class="string">"nto"</span>,
<a href=#125 id=125 data-nosnippet>125</a> ))]
<a href=#126 id=126 data-nosnippet>126</a> </span><span class="macro">syscall!</span>(fcntl(s.as_raw_fd(), libc::F_SETFL, libc::O_NONBLOCK))<span class="question-mark">?</span>;
<a href=#127 id=127 data-nosnippet>127</a>
<a href=#128 id=128 data-nosnippet>128</a> <span class="prelude-val">Ok</span>(s)
<a href=#129 id=129 data-nosnippet>129</a> })
<a href=#130 id=130 data-nosnippet>130</a> }<span class="question-mark">?</span>;
<a href=#131 id=131 data-nosnippet>131</a>
<a href=#132 id=132 data-nosnippet>132</a> <span class="comment">// This is safe because `accept` calls above ensures the address
<a href=#133 id=133 data-nosnippet>133</a> // initialised.
<a href=#134 id=134 data-nosnippet>134</a> </span><span class="kw">unsafe </span>{ to_socket_addr(addr.as_ptr()) }.map(|addr| (stream, addr))
<a href=#135 id=135 data-nosnippet>135</a>}
</code></pre></div></section></main></body></html>
+37
View File
@@ -0,0 +1,37 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/udp.rs`."><title>udp.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/</div>udp.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::io;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::mem;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::net::{<span class="self">self</span>, SocketAddr};
<a href=#4 id=4 data-nosnippet>4</a><span class="attr">#[cfg(not(target_os = <span class="string">"hermit"</span>))]
<a href=#5 id=5 data-nosnippet>5</a></span><span class="kw">use </span>std::os::fd::{AsRawFd, FromRawFd};
<a href=#6 id=6 data-nosnippet>6</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#7 id=7 data-nosnippet>7</a>// can use `std::os::fd` and be merged with the above.
<a href=#8 id=8 data-nosnippet>8</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">use </span>std::os::hermit::io::{AsRawFd, FromRawFd};
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::net::{new_ip_socket, socket_addr};
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">pub fn </span>bind(addr: SocketAddr) -&gt; io::Result&lt;net::UdpSocket&gt; {
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">let </span>fd = new_ip_socket(addr, libc::SOCK_DGRAM)<span class="question-mark">?</span>;
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">let </span>socket = <span class="kw">unsafe </span>{ net::UdpSocket::from_raw_fd(fd) };
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span>(raw_addr, raw_addr_length) = socket_addr(<span class="kw-2">&amp;</span>addr);
<a href=#18 id=18 data-nosnippet>18</a> <span class="macro">syscall!</span>(bind(fd, raw_addr.as_ptr(), raw_addr_length))<span class="question-mark">?</span>;
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a> <span class="prelude-val">Ok</span>(socket)
<a href=#21 id=21 data-nosnippet>21</a>}
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>only_v6(socket: <span class="kw-2">&amp;</span>net::UdpSocket) -&gt; io::Result&lt;bool&gt; {
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">let </span><span class="kw-2">mut </span>optval: libc::c_int = <span class="number">0</span>;
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">let </span><span class="kw-2">mut </span>optlen = mem::size_of::&lt;libc::c_int&gt;() <span class="kw">as </span>libc::socklen_t;
<a href=#26 id=26 data-nosnippet>26</a>
<a href=#27 id=27 data-nosnippet>27</a> <span class="macro">syscall!</span>(getsockopt(
<a href=#28 id=28 data-nosnippet>28</a> socket.as_raw_fd(),
<a href=#29 id=29 data-nosnippet>29</a> libc::IPPROTO_IPV6,
<a href=#30 id=30 data-nosnippet>30</a> libc::IPV6_V6ONLY,
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw-2">&amp;mut </span>optval <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_ as </span><span class="kw-2">*mut </span><span class="kw">_</span>,
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw-2">&amp;mut </span>optlen,
<a href=#33 id=33 data-nosnippet>33</a> ))<span class="question-mark">?</span>;
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="prelude-val">Ok</span>(<span class="macro">optval !</span>= <span class="number">0</span>)
<a href=#36 id=36 data-nosnippet>36</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,26 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/uds/datagram.rs`."><title>datagram.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/uds/</div>datagram.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::io;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::os::fd::{AsRawFd, FromRawFd};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::os::unix::net::{<span class="self">self</span>, SocketAddr};
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::net::new_socket;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::uds::unix_addr;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>bind_addr(address: <span class="kw-2">&amp;</span>SocketAddr) -&gt; io::Result&lt;net::UnixDatagram&gt; {
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">let </span>socket = unbound()<span class="question-mark">?</span>;
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a> <span class="kw">let </span>(unix_address, addrlen) = unix_addr(address);
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">let </span>sockaddr = <span class="kw-2">&amp;</span>unix_address <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr_un <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr;
<a href=#13 id=13 data-nosnippet>13</a> <span class="macro">syscall!</span>(bind(socket.as_raw_fd(), sockaddr, addrlen))<span class="question-mark">?</span>;
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a> <span class="prelude-val">Ok</span>(socket)
<a href=#16 id=16 data-nosnippet>16</a>}
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>unbound() -&gt; io::Result&lt;net::UnixDatagram&gt; {
<a href=#19 id=19 data-nosnippet>19</a> <span class="kw">let </span>fd = new_socket(libc::AF_UNIX, libc::SOCK_DGRAM)<span class="question-mark">?</span>;
<a href=#20 id=20 data-nosnippet>20</a> <span class="prelude-val">Ok</span>(<span class="kw">unsafe </span>{ net::UnixDatagram::from_raw_fd(fd) })
<a href=#21 id=21 data-nosnippet>21</a>}
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>pair() -&gt; io::Result&lt;(net::UnixDatagram, net::UnixDatagram)&gt; {
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">super</span>::pair(libc::SOCK_DGRAM)
<a href=#25 id=25 data-nosnippet>25</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,123 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/uds/listener.rs`."><title>listener.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/uds/</div>listener.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::ffi::OsStr;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::os::fd::{AsRawFd, FromRawFd};
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::os::unix::ffi::OsStrExt;
<a href=#4 id=4 data-nosnippet>4</a><span class="kw">use </span>std::os::unix::net::{<span class="self">self</span>, SocketAddr};
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::path::Path;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>std::{io, mem};
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span><span class="kw">crate</span>::net::UnixStream;
<a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::net::new_socket;
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::uds::{path_offset, unix_addr};
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span><span class="kw">crate</span>::sys::LISTEN_BACKLOG_SIZE;
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>bind_addr(address: <span class="kw-2">&amp;</span>SocketAddr) -&gt; io::Result&lt;net::UnixListener&gt; {
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">let </span>fd = new_socket(libc::AF_UNIX, libc::SOCK_STREAM)<span class="question-mark">?</span>;
<a href=#15 id=15 data-nosnippet>15</a> <span class="kw">let </span>socket = <span class="kw">unsafe </span>{ net::UnixListener::from_raw_fd(fd) };
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span>(unix_address, addrlen) = unix_addr(address);
<a href=#18 id=18 data-nosnippet>18</a> <span class="kw">let </span>sockaddr = <span class="kw-2">&amp;</span>unix_address <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr_un <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr;
<a href=#19 id=19 data-nosnippet>19</a> <span class="macro">syscall!</span>(bind(fd, sockaddr, addrlen))<span class="question-mark">?</span>;
<a href=#20 id=20 data-nosnippet>20</a> <span class="macro">syscall!</span>(listen(fd, LISTEN_BACKLOG_SIZE))<span class="question-mark">?</span>;
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a> <span class="prelude-val">Ok</span>(socket)
<a href=#23 id=23 data-nosnippet>23</a>}
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>accept(listener: <span class="kw-2">&amp;</span>net::UnixListener) -&gt; io::Result&lt;(UnixStream, SocketAddr)&gt; {
<a href=#26 id=26 data-nosnippet>26</a> <span class="comment">// SAFETY: `libc::sockaddr_un` zero filled is properly initialized.
<a href=#27 id=27 data-nosnippet>27</a> //
<a href=#28 id=28 data-nosnippet>28</a> // `0` is a valid value for `sockaddr_un::sun_family`; it is
<a href=#29 id=29 data-nosnippet>29</a> // `libc::AF_UNSPEC`.
<a href=#30 id=30 data-nosnippet>30</a> //
<a href=#31 id=31 data-nosnippet>31</a> // `[0; 108]` is a valid value for `sockaddr_un::sun_path`; it begins an
<a href=#32 id=32 data-nosnippet>32</a> // abstract path.
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="kw">let </span><span class="kw-2">mut </span>sockaddr = <span class="kw">unsafe </span>{ mem::zeroed::&lt;libc::sockaddr_un&gt;() };
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="kw">let </span><span class="kw-2">mut </span>socklen = mem::size_of_val(<span class="kw-2">&amp;</span>sockaddr) <span class="kw">as </span>libc::socklen_t;
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a> <span class="attr">#[cfg(not(any(
<a href=#38 id=38 data-nosnippet>38</a> target_os = <span class="string">"aix"</span>,
<a href=#39 id=39 data-nosnippet>39</a> target_os = <span class="string">"haiku"</span>,
<a href=#40 id=40 data-nosnippet>40</a> target_os = <span class="string">"ios"</span>,
<a href=#41 id=41 data-nosnippet>41</a> target_os = <span class="string">"macos"</span>,
<a href=#42 id=42 data-nosnippet>42</a> target_os = <span class="string">"netbsd"</span>,
<a href=#43 id=43 data-nosnippet>43</a> target_os = <span class="string">"redox"</span>,
<a href=#44 id=44 data-nosnippet>44</a> target_os = <span class="string">"tvos"</span>,
<a href=#45 id=45 data-nosnippet>45</a> target_os = <span class="string">"visionos"</span>,
<a href=#46 id=46 data-nosnippet>46</a> target_os = <span class="string">"watchos"</span>,
<a href=#47 id=47 data-nosnippet>47</a> target_os = <span class="string">"espidf"</span>,
<a href=#48 id=48 data-nosnippet>48</a> target_os = <span class="string">"vita"</span>,
<a href=#49 id=49 data-nosnippet>49</a> target_os = <span class="string">"nto"</span>,
<a href=#50 id=50 data-nosnippet>50</a> <span class="comment">// Android x86's seccomp profile forbids calls to `accept4(2)`
<a href=#51 id=51 data-nosnippet>51</a> // See https://github.com/tokio-rs/mio/issues/1445 for details
<a href=#52 id=52 data-nosnippet>52</a> </span>all(target_arch = <span class="string">"x86"</span>, target_os = <span class="string">"android"</span>),
<a href=#53 id=53 data-nosnippet>53</a> )))]
<a href=#54 id=54 data-nosnippet>54</a> </span><span class="kw">let </span>socket = {
<a href=#55 id=55 data-nosnippet>55</a> <span class="kw">let </span>flags = libc::SOCK_NONBLOCK | libc::SOCK_CLOEXEC;
<a href=#56 id=56 data-nosnippet>56</a> <span class="macro">syscall!</span>(accept4(
<a href=#57 id=57 data-nosnippet>57</a> listener.as_raw_fd(),
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw-2">&amp;mut </span>sockaddr <span class="kw">as </span><span class="kw-2">*mut </span>libc::sockaddr_un <span class="kw">as </span><span class="kw-2">*mut </span>libc::sockaddr,
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw-2">&amp;mut </span>socklen,
<a href=#60 id=60 data-nosnippet>60</a> flags
<a href=#61 id=61 data-nosnippet>61</a> ))
<a href=#62 id=62 data-nosnippet>62</a> .map(|socket| <span class="kw">unsafe </span>{ net::UnixStream::from_raw_fd(socket) })
<a href=#63 id=63 data-nosnippet>63</a> };
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a> <span class="attr">#[cfg(any(
<a href=#66 id=66 data-nosnippet>66</a> target_os = <span class="string">"aix"</span>,
<a href=#67 id=67 data-nosnippet>67</a> target_os = <span class="string">"haiku"</span>,
<a href=#68 id=68 data-nosnippet>68</a> target_os = <span class="string">"ios"</span>,
<a href=#69 id=69 data-nosnippet>69</a> target_os = <span class="string">"macos"</span>,
<a href=#70 id=70 data-nosnippet>70</a> target_os = <span class="string">"netbsd"</span>,
<a href=#71 id=71 data-nosnippet>71</a> target_os = <span class="string">"redox"</span>,
<a href=#72 id=72 data-nosnippet>72</a> target_os = <span class="string">"tvos"</span>,
<a href=#73 id=73 data-nosnippet>73</a> target_os = <span class="string">"visionos"</span>,
<a href=#74 id=74 data-nosnippet>74</a> target_os = <span class="string">"watchos"</span>,
<a href=#75 id=75 data-nosnippet>75</a> target_os = <span class="string">"espidf"</span>,
<a href=#76 id=76 data-nosnippet>76</a> target_os = <span class="string">"vita"</span>,
<a href=#77 id=77 data-nosnippet>77</a> target_os = <span class="string">"nto"</span>,
<a href=#78 id=78 data-nosnippet>78</a> all(target_arch = <span class="string">"x86"</span>, target_os = <span class="string">"android"</span>)
<a href=#79 id=79 data-nosnippet>79</a> ))]
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">let </span>socket = <span class="macro">syscall!</span>(accept(
<a href=#81 id=81 data-nosnippet>81</a> listener.as_raw_fd(),
<a href=#82 id=82 data-nosnippet>82</a> <span class="kw-2">&amp;mut </span>sockaddr <span class="kw">as </span><span class="kw-2">*mut </span>libc::sockaddr_un <span class="kw">as </span><span class="kw-2">*mut </span>libc::sockaddr,
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw-2">&amp;mut </span>socklen,
<a href=#84 id=84 data-nosnippet>84</a> ))
<a href=#85 id=85 data-nosnippet>85</a> .and_then(|socket| {
<a href=#86 id=86 data-nosnippet>86</a> <span class="comment">// Ensure the socket is closed if either of the `fcntl` calls
<a href=#87 id=87 data-nosnippet>87</a> // error below.
<a href=#88 id=88 data-nosnippet>88</a> </span><span class="kw">let </span>s = <span class="kw">unsafe </span>{ net::UnixStream::from_raw_fd(socket) };
<a href=#89 id=89 data-nosnippet>89</a> <span class="attr">#[cfg(not(any(target_os = <span class="string">"espidf"</span>, target_os = <span class="string">"vita"</span>)))]
<a href=#90 id=90 data-nosnippet>90</a> </span><span class="macro">syscall!</span>(fcntl(socket, libc::F_SETFD, libc::FD_CLOEXEC))<span class="question-mark">?</span>;
<a href=#91 id=91 data-nosnippet>91</a>
<a href=#92 id=92 data-nosnippet>92</a> <span class="comment">// See https://github.com/tokio-rs/mio/issues/1450
<a href=#93 id=93 data-nosnippet>93</a> </span><span class="attr">#[cfg(any(
<a href=#94 id=94 data-nosnippet>94</a> all(target_arch = <span class="string">"x86"</span>, target_os = <span class="string">"android"</span>),
<a href=#95 id=95 data-nosnippet>95</a> target_os = <span class="string">"espidf"</span>,
<a href=#96 id=96 data-nosnippet>96</a> target_os = <span class="string">"vita"</span>,
<a href=#97 id=97 data-nosnippet>97</a> target_os = <span class="string">"nto"</span>,
<a href=#98 id=98 data-nosnippet>98</a> ))]
<a href=#99 id=99 data-nosnippet>99</a> </span><span class="macro">syscall!</span>(fcntl(socket, libc::F_SETFL, libc::O_NONBLOCK))<span class="question-mark">?</span>;
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a> <span class="prelude-val">Ok</span>(s)
<a href=#102 id=102 data-nosnippet>102</a> });
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span>socket = socket.map(UnixStream::from_std)<span class="question-mark">?</span>;
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="attr">#[allow(unused_mut)] </span><span class="comment">// See below.
<a href=#107 id=107 data-nosnippet>107</a> </span><span class="kw">let </span><span class="kw-2">mut </span>path_len = socklen <span class="kw">as </span>usize - path_offset(<span class="kw-2">&amp;</span>sockaddr);
<a href=#108 id=108 data-nosnippet>108</a> <span class="comment">// On FreeBSD and Darwin, it returns a length of 14/16, but an unnamed (all
<a href=#109 id=109 data-nosnippet>109</a> // zero) address. Map that to a length of 0 to match other OS.
<a href=#110 id=110 data-nosnippet>110</a> </span><span class="kw">if </span>sockaddr.sun_path[<span class="number">0</span>] == <span class="number">0 </span>{
<a href=#111 id=111 data-nosnippet>111</a> path_len = <span class="number">0</span>;
<a href=#112 id=112 data-nosnippet>112</a> }
<a href=#113 id=113 data-nosnippet>113</a> <span class="comment">// SAFETY: going from i8 to u8 is fine in this context.
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">let </span><span class="kw-2">mut </span>path =
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">unsafe </span>{ <span class="kw-2">&amp;*</span>(<span class="kw-2">&amp;</span>sockaddr.sun_path[..path_len] <span class="kw">as </span><span class="kw-2">*const </span>[libc::c_char] <span class="kw">as </span><span class="kw-2">*const </span>[u8]) };
<a href=#116 id=116 data-nosnippet>116</a> <span class="comment">// Remove last null as `SocketAddr::from_pathname` doesn't accept it.
<a href=#117 id=117 data-nosnippet>117</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="number">0</span>) = path.last() {
<a href=#118 id=118 data-nosnippet>118</a> path = <span class="kw-2">&amp;</span>path[..path.len() - <span class="number">1</span>];
<a href=#119 id=119 data-nosnippet>119</a> }
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">let </span>address = SocketAddr::from_pathname(Path::new(OsStr::from_bytes(path)))<span class="question-mark">?</span>;
<a href=#121 id=121 data-nosnippet>121</a> <span class="prelude-val">Ok</span>((socket, address))
<a href=#122 id=122 data-nosnippet>122</a>}
</code></pre></div></section></main></body></html>
+178
View File
@@ -0,0 +1,178 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/uds/mod.rs`."><title>mod.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/uds/</div>mod.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="attr">#[cfg(target_os = <span class="string">"android"</span>)]
<a href=#2 id=2 data-nosnippet>2</a></span><span class="kw">use </span>std::os::android::net::SocketAddrExt;
<a href=#3 id=3 data-nosnippet>3</a><span class="attr">#[cfg(target_os = <span class="string">"linux"</span>)]
<a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">use </span>std::os::linux::net::SocketAddrExt;
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>std::os::unix::ffi::OsStrExt;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span>std::os::unix::io::FromRawFd;
<a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>std::os::unix::net::SocketAddr;
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>std::{io, mem, ptr};
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>datagram;
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>listener;
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>stream;
<a href=#13 id=13 data-nosnippet>13</a>
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">const </span>UNNAMED_ADDRESS: <span class="kw-2">&amp;</span>[u8] = <span class="kw-2">&amp;</span>[];
<a href=#15 id=15 data-nosnippet>15</a>
<a href=#16 id=16 data-nosnippet>16</a><span class="doccomment">/// Get the `sun_path` field offset of `sockaddr_un` for the target OS.
<a href=#17 id=17 data-nosnippet>17</a>///
<a href=#18 id=18 data-nosnippet>18</a>/// On Linux, this function equates to the same value as
<a href=#19 id=19 data-nosnippet>19</a>/// `size_of::&lt;sa_family_t&gt;()`, but some other implementations include
<a href=#20 id=20 data-nosnippet>20</a>/// other fields before `sun_path`, so the expression more portably
<a href=#21 id=21 data-nosnippet>21</a>/// describes the size of the address structure.
<a href=#22 id=22 data-nosnippet>22</a></span><span class="kw">fn </span>path_offset(sockaddr: <span class="kw-2">&amp;</span>libc::sockaddr_un) -&gt; usize {
<a href=#23 id=23 data-nosnippet>23</a> <span class="kw">let </span>base = sockaddr <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize;
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">let </span>path = <span class="kw-2">&amp;</span>sockaddr.sun_path <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize;
<a href=#25 id=25 data-nosnippet>25</a> path - base
<a href=#26 id=26 data-nosnippet>26</a>}
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="doccomment">/// Converts a Rust `SocketAddr` into the system representation.
<a href=#29 id=29 data-nosnippet>29</a></span><span class="kw">fn </span>unix_addr(address: <span class="kw-2">&amp;</span>SocketAddr) -&gt; (libc::sockaddr_un, libc::socklen_t) {
<a href=#30 id=30 data-nosnippet>30</a> <span class="comment">// SAFETY: `libc::sockaddr_un` zero filled is properly initialized.
<a href=#31 id=31 data-nosnippet>31</a> //
<a href=#32 id=32 data-nosnippet>32</a> // `0` is a valid value for `sockaddr_un::sun_family`; it is
<a href=#33 id=33 data-nosnippet>33</a> // `libc::AF_UNSPEC`.
<a href=#34 id=34 data-nosnippet>34</a> //
<a href=#35 id=35 data-nosnippet>35</a> // `[0; 108]` is a valid value for `sockaddr_un::sun_path`; it begins an
<a href=#36 id=36 data-nosnippet>36</a> // abstract path.
<a href=#37 id=37 data-nosnippet>37</a> </span><span class="kw">let </span><span class="kw-2">mut </span>sockaddr = <span class="kw">unsafe </span>{ mem::zeroed::&lt;libc::sockaddr_un&gt;() };
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a> sockaddr.sun_family = libc::AF_UNIX <span class="kw">as </span>libc::sa_family_t;
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="attr">#[allow(unused_mut)] </span><span class="comment">// Only used with abstract namespaces.
<a href=#42 id=42 data-nosnippet>42</a> </span><span class="kw">let </span><span class="kw-2">mut </span>offset = <span class="number">0</span>;
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span>addr = <span class="kw">match </span>address.as_pathname() {
<a href=#44 id=44 data-nosnippet>44</a> <span class="prelude-val">Some</span>(path) =&gt; path.as_os_str().as_bytes(),
<a href=#45 id=45 data-nosnippet>45</a> <span class="attr">#[cfg(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>))]
<a href=#46 id=46 data-nosnippet>46</a> </span><span class="prelude-val">None </span>=&gt; <span class="kw">match </span>address.as_abstract_name() {
<a href=#47 id=47 data-nosnippet>47</a> <span class="prelude-val">Some</span>(name) =&gt; {
<a href=#48 id=48 data-nosnippet>48</a> offset += <span class="number">1</span>;
<a href=#49 id=49 data-nosnippet>49</a> name
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a> <span class="prelude-val">None </span>=&gt; UNNAMED_ADDRESS,
<a href=#52 id=52 data-nosnippet>52</a> },
<a href=#53 id=53 data-nosnippet>53</a> <span class="attr">#[cfg(not(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>)))]
<a href=#54 id=54 data-nosnippet>54</a> </span><span class="prelude-val">None </span>=&gt; UNNAMED_ADDRESS,
<a href=#55 id=55 data-nosnippet>55</a> };
<a href=#56 id=56 data-nosnippet>56</a>
<a href=#57 id=57 data-nosnippet>57</a> <span class="comment">// SAFETY: `addr` and `sockaddr.sun_path` are not overlapping and both point
<a href=#58 id=58 data-nosnippet>58</a> // to valid memory.
<a href=#59 id=59 data-nosnippet>59</a> // SAFETY: since `addr` is a valid Unix address, it must not be larger than
<a href=#60 id=60 data-nosnippet>60</a> // `SUN_LEN` bytes, thus we won't overwrite the size of sockaddr.sun_path.
<a href=#61 id=61 data-nosnippet>61</a> // SAFETY: null byte is already written because we zeroed the address above.
<a href=#62 id=62 data-nosnippet>62</a> </span><span class="macro">debug_assert!</span>(offset + addr.len() &lt;= sockaddr.sun_path.len());
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">unsafe </span>{
<a href=#64 id=64 data-nosnippet>64</a> ptr::copy_nonoverlapping(
<a href=#65 id=65 data-nosnippet>65</a> addr.as_ptr(),
<a href=#66 id=66 data-nosnippet>66</a> sockaddr.sun_path.as_mut_ptr().add(offset).cast(),
<a href=#67 id=67 data-nosnippet>67</a> addr.len(),
<a href=#68 id=68 data-nosnippet>68</a> )
<a href=#69 id=69 data-nosnippet>69</a> };
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">let </span><span class="kw-2">mut </span>addrlen = path_offset(<span class="kw-2">&amp;</span>sockaddr) + addr.len();
<a href=#72 id=72 data-nosnippet>72</a> <span class="comment">// +1 for null byte at the end of the path, not needed for abstract
<a href=#73 id=73 data-nosnippet>73</a> // namespaces (which start with a null byte).
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">match </span>addr.first() {
<a href=#75 id=75 data-nosnippet>75</a> <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">0</span>) | <span class="prelude-val">None </span>=&gt; {}
<a href=#76 id=76 data-nosnippet>76</a> <span class="prelude-val">Some</span>(<span class="kw">_</span>) =&gt; addrlen += <span class="number">1</span>,
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a> <span class="comment">// SAFETY: the length is fine to cast to `socklen_t` as it's 32 bits and the
<a href=#80 id=80 data-nosnippet>80</a> // address can be at most `SUN_LEN` bytes.
<a href=#81 id=81 data-nosnippet>81</a> </span>(sockaddr, addrlen <span class="kw">as _</span>)
<a href=#82 id=82 data-nosnippet>82</a>}
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a><span class="kw">fn </span>pair&lt;T&gt;(flags: libc::c_int) -&gt; io::Result&lt;(T, T)&gt;
<a href=#85 id=85 data-nosnippet>85</a><span class="kw">where
<a href=#86 id=86 data-nosnippet>86</a> </span>T: FromRawFd,
<a href=#87 id=87 data-nosnippet>87</a>{
<a href=#88 id=88 data-nosnippet>88</a> <span class="attr">#[cfg(not(any(
<a href=#89 id=89 data-nosnippet>89</a> target_os = <span class="string">"aix"</span>,
<a href=#90 id=90 data-nosnippet>90</a> target_os = <span class="string">"haiku"</span>,
<a href=#91 id=91 data-nosnippet>91</a> target_os = <span class="string">"ios"</span>,
<a href=#92 id=92 data-nosnippet>92</a> target_os = <span class="string">"macos"</span>,
<a href=#93 id=93 data-nosnippet>93</a> target_os = <span class="string">"nto"</span>,
<a href=#94 id=94 data-nosnippet>94</a> target_os = <span class="string">"tvos"</span>,
<a href=#95 id=95 data-nosnippet>95</a> target_os = <span class="string">"visionos"</span>,
<a href=#96 id=96 data-nosnippet>96</a> target_os = <span class="string">"watchos"</span>,
<a href=#97 id=97 data-nosnippet>97</a> target_os = <span class="string">"espidf"</span>,
<a href=#98 id=98 data-nosnippet>98</a> target_os = <span class="string">"vita"</span>,
<a href=#99 id=99 data-nosnippet>99</a> )))]
<a href=#100 id=100 data-nosnippet>100</a> </span><span class="kw">let </span>flags = flags | libc::SOCK_NONBLOCK | libc::SOCK_CLOEXEC;
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a> <span class="kw">let </span><span class="kw-2">mut </span>fds = [-<span class="number">1</span>; <span class="number">2</span>];
<a href=#103 id=103 data-nosnippet>103</a> <span class="macro">syscall!</span>(socketpair(libc::AF_UNIX, flags, <span class="number">0</span>, fds.as_mut_ptr()))<span class="question-mark">?</span>;
<a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span>pair = <span class="kw">unsafe </span>{ (T::from_raw_fd(fds[<span class="number">0</span>]), T::from_raw_fd(fds[<span class="number">1</span>])) };
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> <span class="comment">// Darwin (and others) doesn't have SOCK_NONBLOCK or SOCK_CLOEXEC.
<a href=#107 id=107 data-nosnippet>107</a> //
<a href=#108 id=108 data-nosnippet>108</a> // In order to set those flags, additional `fcntl` sys calls must be
<a href=#109 id=109 data-nosnippet>109</a> // performed. If a `fnctl` fails after the sockets have been created,
<a href=#110 id=110 data-nosnippet>110</a> // the file descriptors will leak. Creating `pair` above ensures that if
<a href=#111 id=111 data-nosnippet>111</a> // there is an error, the file descriptors are closed.
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="attr">#[cfg(any(
<a href=#113 id=113 data-nosnippet>113</a> target_os = <span class="string">"aix"</span>,
<a href=#114 id=114 data-nosnippet>114</a> target_os = <span class="string">"haiku"</span>,
<a href=#115 id=115 data-nosnippet>115</a> target_os = <span class="string">"ios"</span>,
<a href=#116 id=116 data-nosnippet>116</a> target_os = <span class="string">"macos"</span>,
<a href=#117 id=117 data-nosnippet>117</a> target_os = <span class="string">"nto"</span>,
<a href=#118 id=118 data-nosnippet>118</a> target_os = <span class="string">"tvos"</span>,
<a href=#119 id=119 data-nosnippet>119</a> target_os = <span class="string">"visionos"</span>,
<a href=#120 id=120 data-nosnippet>120</a> target_os = <span class="string">"watchos"</span>,
<a href=#121 id=121 data-nosnippet>121</a> target_os = <span class="string">"espidf"</span>,
<a href=#122 id=122 data-nosnippet>122</a> target_os = <span class="string">"vita"</span>,
<a href=#123 id=123 data-nosnippet>123</a> ))]
<a href=#124 id=124 data-nosnippet>124</a> </span>{
<a href=#125 id=125 data-nosnippet>125</a> <span class="macro">syscall!</span>(fcntl(fds[<span class="number">0</span>], libc::F_SETFL, libc::O_NONBLOCK))<span class="question-mark">?</span>;
<a href=#126 id=126 data-nosnippet>126</a> <span class="attr">#[cfg(not(any(target_os = <span class="string">"espidf"</span>, target_os = <span class="string">"vita"</span>, target_os = <span class="string">"nto"</span>)))]
<a href=#127 id=127 data-nosnippet>127</a> </span><span class="macro">syscall!</span>(fcntl(fds[<span class="number">0</span>], libc::F_SETFD, libc::FD_CLOEXEC))<span class="question-mark">?</span>;
<a href=#128 id=128 data-nosnippet>128</a> <span class="macro">syscall!</span>(fcntl(fds[<span class="number">1</span>], libc::F_SETFL, libc::O_NONBLOCK))<span class="question-mark">?</span>;
<a href=#129 id=129 data-nosnippet>129</a> <span class="attr">#[cfg(not(any(target_os = <span class="string">"espidf"</span>, target_os = <span class="string">"vita"</span>, target_os = <span class="string">"nto"</span>)))]
<a href=#130 id=130 data-nosnippet>130</a> </span><span class="macro">syscall!</span>(fcntl(fds[<span class="number">1</span>], libc::F_SETFD, libc::FD_CLOEXEC))<span class="question-mark">?</span>;
<a href=#131 id=131 data-nosnippet>131</a> }
<a href=#132 id=132 data-nosnippet>132</a>
<a href=#133 id=133 data-nosnippet>133</a> <span class="prelude-val">Ok</span>(pair)
<a href=#134 id=134 data-nosnippet>134</a>}
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a><span class="attr">#[cfg(test)]
<a href=#137 id=137 data-nosnippet>137</a></span><span class="kw">mod </span>tests {
<a href=#138 id=138 data-nosnippet>138</a> <span class="kw">use </span>std::os::unix::net::SocketAddr;
<a href=#139 id=139 data-nosnippet>139</a> <span class="kw">use </span>std::path::Path;
<a href=#140 id=140 data-nosnippet>140</a> <span class="kw">use </span>std::str;
<a href=#141 id=141 data-nosnippet>141</a>
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">use super</span>::{path_offset, unix_addr};
<a href=#143 id=143 data-nosnippet>143</a>
<a href=#144 id=144 data-nosnippet>144</a> <span class="attr">#[test]
<a href=#145 id=145 data-nosnippet>145</a> </span><span class="kw">fn </span>pathname_address() {
<a href=#146 id=146 data-nosnippet>146</a> <span class="kw">const </span>PATH: <span class="kw-2">&amp;</span>str = <span class="string">"./foo/bar.txt"</span>;
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">const </span>PATH_LEN: usize = <span class="number">13</span>;
<a href=#148 id=148 data-nosnippet>148</a>
<a href=#149 id=149 data-nosnippet>149</a> <span class="comment">// Pathname addresses do have a null terminator, so `socklen` is
<a href=#150 id=150 data-nosnippet>150</a> // expected to be `PATH_LEN` + `offset` + 1.
<a href=#151 id=151 data-nosnippet>151</a> </span><span class="kw">let </span>address = SocketAddr::from_pathname(Path::new(PATH)).unwrap();
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">let </span>(sockaddr, actual) = unix_addr(<span class="kw-2">&amp;</span>address);
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">let </span>offset = path_offset(<span class="kw-2">&amp;</span>sockaddr);
<a href=#154 id=154 data-nosnippet>154</a> <span class="kw">let </span>expected = PATH_LEN + offset + <span class="number">1</span>;
<a href=#155 id=155 data-nosnippet>155</a> <span class="macro">assert_eq!</span>(expected <span class="kw">as </span>libc::socklen_t, actual)
<a href=#156 id=156 data-nosnippet>156</a> }
<a href=#157 id=157 data-nosnippet>157</a>
<a href=#158 id=158 data-nosnippet>158</a> <span class="attr">#[test]
<a href=#159 id=159 data-nosnippet>159</a> #[cfg(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>))]
<a href=#160 id=160 data-nosnippet>160</a> </span><span class="kw">fn </span>abstract_address() {
<a href=#161 id=161 data-nosnippet>161</a> <span class="attr">#[cfg(target_os = <span class="string">"android"</span>)]
<a href=#162 id=162 data-nosnippet>162</a> </span><span class="kw">use </span>std::os::android::net::SocketAddrExt;
<a href=#163 id=163 data-nosnippet>163</a> <span class="attr">#[cfg(target_os = <span class="string">"linux"</span>)]
<a href=#164 id=164 data-nosnippet>164</a> </span><span class="kw">use </span>std::os::linux::net::SocketAddrExt;
<a href=#165 id=165 data-nosnippet>165</a>
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">const </span>PATH: <span class="kw-2">&amp;</span>[u8] = <span class="kw-2">&amp;</span>[<span class="number">0</span>, <span class="number">116</span>, <span class="number">111</span>, <span class="number">107</span>, <span class="number">105</span>, <span class="number">111</span>];
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">const </span>PATH_LEN: usize = <span class="number">6</span>;
<a href=#168 id=168 data-nosnippet>168</a>
<a href=#169 id=169 data-nosnippet>169</a> <span class="comment">// Abstract addresses do not have a null terminator, so `socklen` is
<a href=#170 id=170 data-nosnippet>170</a> // expected to be `PATH_LEN` + `offset`.
<a href=#171 id=171 data-nosnippet>171</a> </span><span class="kw">let </span>address = SocketAddr::from_abstract_name(PATH).unwrap();
<a href=#172 id=172 data-nosnippet>172</a> <span class="kw">let </span>(sockaddr, actual) = unix_addr(<span class="kw-2">&amp;</span>address);
<a href=#173 id=173 data-nosnippet>173</a> <span class="kw">let </span>offset = path_offset(<span class="kw-2">&amp;</span>sockaddr);
<a href=#174 id=174 data-nosnippet>174</a> <span class="kw">let </span>expected = PATH_LEN + offset;
<a href=#175 id=175 data-nosnippet>175</a> <span class="macro">assert_eq!</span>(expected <span class="kw">as </span>libc::socklen_t, actual)
<a href=#176 id=176 data-nosnippet>176</a> }
<a href=#177 id=177 data-nosnippet>177</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,26 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/uds/stream.rs`."><title>stream.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/uds/</div>stream.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::io;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::os::fd::FromRawFd;
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::os::unix::net::{<span class="self">self</span>, SocketAddr};
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::net::new_socket;
<a href=#6 id=6 data-nosnippet>6</a><span class="kw">use </span><span class="kw">crate</span>::sys::unix::uds::unix_addr;
<a href=#7 id=7 data-nosnippet>7</a>
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>connect_addr(address: <span class="kw-2">&amp;</span>SocketAddr) -&gt; io::Result&lt;net::UnixStream&gt; {
<a href=#9 id=9 data-nosnippet>9</a> <span class="kw">let </span>fd = new_socket(libc::AF_UNIX, libc::SOCK_STREAM)<span class="question-mark">?</span>;
<a href=#10 id=10 data-nosnippet>10</a> <span class="kw">let </span>socket = <span class="kw">unsafe </span>{ net::UnixStream::from_raw_fd(fd) };
<a href=#11 id=11 data-nosnippet>11</a>
<a href=#12 id=12 data-nosnippet>12</a> <span class="kw">let </span>(unix_address, addrlen) = unix_addr(address);
<a href=#13 id=13 data-nosnippet>13</a> <span class="kw">let </span>sockaddr = <span class="kw-2">&amp;</span>unix_address <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr_un <span class="kw">as </span><span class="kw-2">*const </span>libc::sockaddr;
<a href=#14 id=14 data-nosnippet>14</a> <span class="kw">match </span><span class="macro">syscall!</span>(connect(fd, sockaddr, addrlen)) {
<a href=#15 id=15 data-nosnippet>15</a> <span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; {}
<a href=#16 id=16 data-nosnippet>16</a> <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.raw_os_error() == <span class="prelude-val">Some</span>(libc::EINPROGRESS) =&gt; {}
<a href=#17 id=17 data-nosnippet>17</a> <span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(e),
<a href=#18 id=18 data-nosnippet>18</a> }
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a> <span class="prelude-val">Ok</span>(socket)
<a href=#21 id=21 data-nosnippet>21</a>}
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>pair() -&gt; io::Result&lt;(net::UnixStream, net::UnixStream)&gt; {
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">super</span>::pair(libc::SOCK_STREAM)
<a href=#25 id=25 data-nosnippet>25</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,89 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/sys/unix/waker/eventfd.rs`."><title>eventfd.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../../static.files/storage-e2aeef58.js"></script><script defer src="../../../../../static.files/src-script-813739b1.js"></script><script defer src="../../../../../src-files.js"></script><script defer src="../../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/sys/unix/waker/</div>eventfd.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use </span>std::fs::File;
<a href=#2 id=2 data-nosnippet>2</a><span class="kw">use </span>std::io::{<span class="self">self</span>, Read, Write};
<a href=#3 id=3 data-nosnippet>3</a><span class="attr">#[cfg(not(target_os = <span class="string">"hermit"</span>))]
<a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">use </span>std::os::fd::{AsRawFd, FromRawFd, RawFd};
<a href=#5 id=5 data-nosnippet>5</a><span class="comment">// TODO: once &lt;https://github.com/rust-lang/rust/issues/126198&gt; is fixed this
<a href=#6 id=6 data-nosnippet>6</a>// can use `std::os::fd` and be merged with the above.
<a href=#7 id=7 data-nosnippet>7</a></span><span class="attr">#[cfg(target_os = <span class="string">"hermit"</span>)]
<a href=#8 id=8 data-nosnippet>8</a></span><span class="kw">use </span>std::os::hermit::io::{AsRawFd, FromRawFd, RawFd};
<a href=#9 id=9 data-nosnippet>9</a>
<a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span><span class="kw">crate</span>::sys::Selector;
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">use crate</span>::{Interest, Token};
<a href=#12 id=12 data-nosnippet>12</a>
<a href=#13 id=13 data-nosnippet>13</a><span class="doccomment">/// Waker backed by `eventfd`.
<a href=#14 id=14 data-nosnippet>14</a>///
<a href=#15 id=15 data-nosnippet>15</a>/// `eventfd` is effectively an 64 bit counter. All writes must be of 8
<a href=#16 id=16 data-nosnippet>16</a>/// bytes (64 bits) and are converted (native endian) into an 64 bit
<a href=#17 id=17 data-nosnippet>17</a>/// unsigned integer and added to the count. Reads must also be 8 bytes and
<a href=#18 id=18 data-nosnippet>18</a>/// reset the count to 0, returning the count.
<a href=#19 id=19 data-nosnippet>19</a></span><span class="attr">#[derive(Debug)]
<a href=#20 id=20 data-nosnippet>20</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Waker {
<a href=#21 id=21 data-nosnippet>21</a> fd: File,
<a href=#22 id=22 data-nosnippet>22</a>}
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">impl </span>Waker {
<a href=#25 id=25 data-nosnippet>25</a> <span class="attr">#[allow(dead_code)] </span><span class="comment">// Not used by the `poll(2)` implementation.
<a href=#26 id=26 data-nosnippet>26</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(selector: <span class="kw-2">&amp;</span>Selector, token: Token) -&gt; io::Result&lt;Waker&gt; {
<a href=#27 id=27 data-nosnippet>27</a> <span class="kw">let </span>waker = Waker::new_unregistered()<span class="question-mark">?</span>;
<a href=#28 id=28 data-nosnippet>28</a> selector.register(waker.fd.as_raw_fd(), token, Interest::READABLE)<span class="question-mark">?</span>;
<a href=#29 id=29 data-nosnippet>29</a> <span class="prelude-val">Ok</span>(waker)
<a href=#30 id=30 data-nosnippet>30</a> }
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_unregistered() -&gt; io::Result&lt;Waker&gt; {
<a href=#33 id=33 data-nosnippet>33</a> <span class="attr">#[cfg(not(target_os = <span class="string">"espidf"</span>))]
<a href=#34 id=34 data-nosnippet>34</a> </span><span class="kw">let </span>flags = libc::EFD_CLOEXEC | libc::EFD_NONBLOCK;
<a href=#35 id=35 data-nosnippet>35</a> <span class="comment">// ESP-IDF is EFD_NONBLOCK by default and errors if you try to pass this flag.
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="attr">#[cfg(target_os = <span class="string">"espidf"</span>)]
<a href=#37 id=37 data-nosnippet>37</a> </span><span class="kw">let </span>flags = <span class="number">0</span>;
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">let </span>fd = <span class="macro">syscall!</span>(eventfd(<span class="number">0</span>, flags))<span class="question-mark">?</span>;
<a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span>file = <span class="kw">unsafe </span>{ File::from_raw_fd(fd) };
<a href=#40 id=40 data-nosnippet>40</a> <span class="prelude-val">Ok</span>(Waker { fd: file })
<a href=#41 id=41 data-nosnippet>41</a> }
<a href=#42 id=42 data-nosnippet>42</a>
<a href=#43 id=43 data-nosnippet>43</a> <span class="attr">#[allow(clippy::unused_io_amount)] </span><span class="comment">// Don't care about partial writes.
<a href=#44 id=44 data-nosnippet>44</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>wake(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#45 id=45 data-nosnippet>45</a> <span class="comment">// The epoll emulation on some illumos systems currently requires
<a href=#46 id=46 data-nosnippet>46</a> // the eventfd to be read before an edge-triggered read event is
<a href=#47 id=47 data-nosnippet>47</a> // generated.
<a href=#48 id=48 data-nosnippet>48</a> // See https://www.illumos.org/issues/16700.
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="attr">#[cfg(target_os = <span class="string">"illumos"</span>)]
<a href=#50 id=50 data-nosnippet>50</a> </span><span class="self">self</span>.reset()<span class="question-mark">?</span>;
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">let </span>buf: [u8; <span class="number">8</span>] = <span class="number">1u64</span>.to_ne_bytes();
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">match </span>(<span class="kw-2">&amp;</span><span class="self">self</span>.fd).write(<span class="kw-2">&amp;</span>buf) {
<a href=#54 id=54 data-nosnippet>54</a> <span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="prelude-val">Ok</span>(()),
<a href=#55 id=55 data-nosnippet>55</a> <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock =&gt; {
<a href=#56 id=56 data-nosnippet>56</a> <span class="comment">// Writing only blocks if the counter is going to overflow.
<a href=#57 id=57 data-nosnippet>57</a> // So we'll reset the counter to 0 and wake it again.
<a href=#58 id=58 data-nosnippet>58</a> </span><span class="self">self</span>.reset()<span class="question-mark">?</span>;
<a href=#59 id=59 data-nosnippet>59</a> <span class="self">self</span>.wake()
<a href=#60 id=60 data-nosnippet>60</a> }
<a href=#61 id=61 data-nosnippet>61</a> <span class="prelude-val">Err</span>(err) =&gt; <span class="prelude-val">Err</span>(err),
<a href=#62 id=62 data-nosnippet>62</a> }
<a href=#63 id=63 data-nosnippet>63</a> }
<a href=#64 id=64 data-nosnippet>64</a>
<a href=#65 id=65 data-nosnippet>65</a> <span class="attr">#[allow(dead_code)] </span><span class="comment">// Only used by the `poll(2)` implementation.
<a href=#66 id=66 data-nosnippet>66</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>ack_and_reset(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let _ </span>= <span class="self">self</span>.reset();
<a href=#68 id=68 data-nosnippet>68</a> }
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a> <span class="doccomment">/// Reset the eventfd object, only need to call this if `wake` fails.
<a href=#71 id=71 data-nosnippet>71</a> </span><span class="attr">#[allow(clippy::unused_io_amount)] </span><span class="comment">// Don't care about partial reads.
<a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">fn </span>reset(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let </span><span class="kw-2">mut </span>buf: [u8; <span class="number">8</span>] = <span class="number">0u64</span>.to_ne_bytes();
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">match </span>(<span class="kw-2">&amp;</span><span class="self">self</span>.fd).read(<span class="kw-2">&amp;mut </span>buf) {
<a href=#75 id=75 data-nosnippet>75</a> <span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="prelude-val">Ok</span>(()),
<a href=#76 id=76 data-nosnippet>76</a> <span class="comment">// If the `Waker` hasn't been awoken yet this will return a
<a href=#77 id=77 data-nosnippet>77</a> // `WouldBlock` error which we can safely ignore.
<a href=#78 id=78 data-nosnippet>78</a> </span><span class="prelude-val">Err</span>(<span class="kw-2">ref </span>err) <span class="kw">if </span>err.kind() == io::ErrorKind::WouldBlock =&gt; <span class="prelude-val">Ok</span>(()),
<a href=#79 id=79 data-nosnippet>79</a> <span class="prelude-val">Err</span>(err) =&gt; <span class="prelude-val">Err</span>(err),
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a>}
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a><span class="kw">impl </span>AsRawFd <span class="kw">for </span>Waker {
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; RawFd {
<a href=#86 id=86 data-nosnippet>86</a> <span class="self">self</span>.fd.as_raw_fd()
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a>}
</code></pre></div></section></main></body></html>
+139
View File
@@ -0,0 +1,139 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/token.rs`."><title>token.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>token.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">/// Associates readiness events with [`event::Source`]s.
<a href=#2 id=2 data-nosnippet>2</a>///
<a href=#3 id=3 data-nosnippet>3</a>/// `Token` is a wrapper around `usize` and is used as an argument to
<a href=#4 id=4 data-nosnippet>4</a>/// [`Registry::register`] and [`Registry::reregister`].
<a href=#5 id=5 data-nosnippet>5</a>///
<a href=#6 id=6 data-nosnippet>6</a>/// See [`Poll`] for more documentation on polling.
<a href=#7 id=7 data-nosnippet>7</a>///
<a href=#8 id=8 data-nosnippet>8</a>/// [`event::Source`]: ./event/trait.Source.html
<a href=#9 id=9 data-nosnippet>9</a>/// [`Poll`]: struct.Poll.html
<a href=#10 id=10 data-nosnippet>10</a>/// [`Registry::register`]: struct.Registry.html#method.register
<a href=#11 id=11 data-nosnippet>11</a>/// [`Registry::reregister`]: struct.Registry.html#method.reregister
<a href=#12 id=12 data-nosnippet>12</a>///
<a href=#13 id=13 data-nosnippet>13</a>/// # Example
<a href=#14 id=14 data-nosnippet>14</a>///
<a href=#15 id=15 data-nosnippet>15</a>/// Using `Token` to track which socket generated the event. In this example,
<a href=#16 id=16 data-nosnippet>16</a>/// `HashMap` is used, but usually something like [`slab`] is better.
<a href=#17 id=17 data-nosnippet>17</a>///
<a href=#18 id=18 data-nosnippet>18</a>/// [`slab`]: https://crates.io/crates/slab
<a href=#19 id=19 data-nosnippet>19</a>///
<a href=#20 id=20 data-nosnippet>20</a></span><span class="attr">#[cfg_attr(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>), doc = <span class="string">"```"</span>)]
<a href=#21 id=21 data-nosnippet>21</a>#[cfg_attr(not(all(feature = <span class="string">"os-poll"</span>, feature = <span class="string">"net"</span>)), doc = <span class="string">"```ignore"</span>)]
<a href=#22 id=22 data-nosnippet>22</a></span><span class="doccomment">/// # use std::error::Error;
<a href=#23 id=23 data-nosnippet>23</a>/// # fn main() -&gt; Result&lt;(), Box&lt;dyn Error&gt;&gt; {
<a href=#24 id=24 data-nosnippet>24</a>/// use mio::{Events, Interest, Poll, Token};
<a href=#25 id=25 data-nosnippet>25</a>/// use mio::net::TcpListener;
<a href=#26 id=26 data-nosnippet>26</a>///
<a href=#27 id=27 data-nosnippet>27</a>/// use std::thread;
<a href=#28 id=28 data-nosnippet>28</a>/// use std::io::{self, Read};
<a href=#29 id=29 data-nosnippet>29</a>/// use std::collections::HashMap;
<a href=#30 id=30 data-nosnippet>30</a>///
<a href=#31 id=31 data-nosnippet>31</a>/// // After this number of sockets is accepted, the server will shutdown.
<a href=#32 id=32 data-nosnippet>32</a>/// const MAX_SOCKETS: usize = 32;
<a href=#33 id=33 data-nosnippet>33</a>///
<a href=#34 id=34 data-nosnippet>34</a>/// // Pick a token that will not be used by any other socket and use that one
<a href=#35 id=35 data-nosnippet>35</a>/// // for the listener.
<a href=#36 id=36 data-nosnippet>36</a>/// const LISTENER: Token = Token(1024);
<a href=#37 id=37 data-nosnippet>37</a>///
<a href=#38 id=38 data-nosnippet>38</a>/// // Used to store the sockets.
<a href=#39 id=39 data-nosnippet>39</a>/// let mut sockets = HashMap::new();
<a href=#40 id=40 data-nosnippet>40</a>///
<a href=#41 id=41 data-nosnippet>41</a>/// // This is used to generate a unique token for a socket
<a href=#42 id=42 data-nosnippet>42</a>/// let mut next_socket_index = 0;
<a href=#43 id=43 data-nosnippet>43</a>///
<a href=#44 id=44 data-nosnippet>44</a>/// // The `Poll` instance
<a href=#45 id=45 data-nosnippet>45</a>/// let mut poll = Poll::new()?;
<a href=#46 id=46 data-nosnippet>46</a>///
<a href=#47 id=47 data-nosnippet>47</a>/// // Tcp listener
<a href=#48 id=48 data-nosnippet>48</a>/// let mut listener = TcpListener::bind("127.0.0.1:0".parse()?)?;
<a href=#49 id=49 data-nosnippet>49</a>///
<a href=#50 id=50 data-nosnippet>50</a>/// // Register the listener
<a href=#51 id=51 data-nosnippet>51</a>/// poll.registry().register(&amp;mut listener, LISTENER, Interest::READABLE)?;
<a href=#52 id=52 data-nosnippet>52</a>///
<a href=#53 id=53 data-nosnippet>53</a>/// // Spawn a thread that will connect a bunch of sockets then close them
<a href=#54 id=54 data-nosnippet>54</a>/// let addr = listener.local_addr()?;
<a href=#55 id=55 data-nosnippet>55</a>/// thread::spawn(move || {
<a href=#56 id=56 data-nosnippet>56</a>/// use std::net::TcpStream;
<a href=#57 id=57 data-nosnippet>57</a>///
<a href=#58 id=58 data-nosnippet>58</a>/// // +1 here is to connect an extra socket to signal the socket to close
<a href=#59 id=59 data-nosnippet>59</a>/// for _ in 0..(MAX_SOCKETS+1) {
<a href=#60 id=60 data-nosnippet>60</a>/// // Connect then drop the socket
<a href=#61 id=61 data-nosnippet>61</a>/// let _ = TcpStream::connect(addr).unwrap();
<a href=#62 id=62 data-nosnippet>62</a>/// }
<a href=#63 id=63 data-nosnippet>63</a>/// });
<a href=#64 id=64 data-nosnippet>64</a>///
<a href=#65 id=65 data-nosnippet>65</a>/// // Event storage
<a href=#66 id=66 data-nosnippet>66</a>/// let mut events = Events::with_capacity(1024);
<a href=#67 id=67 data-nosnippet>67</a>///
<a href=#68 id=68 data-nosnippet>68</a>/// // Read buffer, this will never actually get filled
<a href=#69 id=69 data-nosnippet>69</a>/// let mut buf = [0; 256];
<a href=#70 id=70 data-nosnippet>70</a>///
<a href=#71 id=71 data-nosnippet>71</a>/// // The main event loop
<a href=#72 id=72 data-nosnippet>72</a>/// loop {
<a href=#73 id=73 data-nosnippet>73</a>/// // Wait for events
<a href=#74 id=74 data-nosnippet>74</a>/// poll.poll(&amp;mut events, None)?;
<a href=#75 id=75 data-nosnippet>75</a>///
<a href=#76 id=76 data-nosnippet>76</a>/// for event in &amp;events {
<a href=#77 id=77 data-nosnippet>77</a>/// match event.token() {
<a href=#78 id=78 data-nosnippet>78</a>/// LISTENER =&gt; {
<a href=#79 id=79 data-nosnippet>79</a>/// // Perform operations in a loop until `WouldBlock` is
<a href=#80 id=80 data-nosnippet>80</a>/// // encountered.
<a href=#81 id=81 data-nosnippet>81</a>/// loop {
<a href=#82 id=82 data-nosnippet>82</a>/// match listener.accept() {
<a href=#83 id=83 data-nosnippet>83</a>/// Ok((mut socket, _)) =&gt; {
<a href=#84 id=84 data-nosnippet>84</a>/// // Shutdown the server
<a href=#85 id=85 data-nosnippet>85</a>/// if next_socket_index == MAX_SOCKETS {
<a href=#86 id=86 data-nosnippet>86</a>/// return Ok(());
<a href=#87 id=87 data-nosnippet>87</a>/// }
<a href=#88 id=88 data-nosnippet>88</a>///
<a href=#89 id=89 data-nosnippet>89</a>/// // Get the token for the socket
<a href=#90 id=90 data-nosnippet>90</a>/// let token = Token(next_socket_index);
<a href=#91 id=91 data-nosnippet>91</a>/// next_socket_index += 1;
<a href=#92 id=92 data-nosnippet>92</a>///
<a href=#93 id=93 data-nosnippet>93</a>/// // Register the new socket w/ poll
<a href=#94 id=94 data-nosnippet>94</a>/// poll.registry().register(&amp;mut socket, token, Interest::READABLE)?;
<a href=#95 id=95 data-nosnippet>95</a>///
<a href=#96 id=96 data-nosnippet>96</a>/// // Store the socket
<a href=#97 id=97 data-nosnippet>97</a>/// sockets.insert(token, socket);
<a href=#98 id=98 data-nosnippet>98</a>/// }
<a href=#99 id=99 data-nosnippet>99</a>/// Err(ref e) if e.kind() == io::ErrorKind::WouldBlock =&gt; {
<a href=#100 id=100 data-nosnippet>100</a>/// // Socket is not ready anymore, stop accepting
<a href=#101 id=101 data-nosnippet>101</a>/// break;
<a href=#102 id=102 data-nosnippet>102</a>/// }
<a href=#103 id=103 data-nosnippet>103</a>/// e =&gt; panic!("err={:?}", e), // Unexpected error
<a href=#104 id=104 data-nosnippet>104</a>/// }
<a href=#105 id=105 data-nosnippet>105</a>/// }
<a href=#106 id=106 data-nosnippet>106</a>/// }
<a href=#107 id=107 data-nosnippet>107</a>/// token =&gt; {
<a href=#108 id=108 data-nosnippet>108</a>/// // Always operate in a loop
<a href=#109 id=109 data-nosnippet>109</a>/// loop {
<a href=#110 id=110 data-nosnippet>110</a>/// match sockets.get_mut(&amp;token).unwrap().read(&amp;mut buf) {
<a href=#111 id=111 data-nosnippet>111</a>/// Ok(0) =&gt; {
<a href=#112 id=112 data-nosnippet>112</a>/// // Socket is closed, remove it from the map
<a href=#113 id=113 data-nosnippet>113</a>/// sockets.remove(&amp;token);
<a href=#114 id=114 data-nosnippet>114</a>/// break;
<a href=#115 id=115 data-nosnippet>115</a>/// }
<a href=#116 id=116 data-nosnippet>116</a>/// // Data is not actually sent in this example
<a href=#117 id=117 data-nosnippet>117</a>/// Ok(_) =&gt; unreachable!(),
<a href=#118 id=118 data-nosnippet>118</a>/// Err(ref e) if e.kind() == io::ErrorKind::WouldBlock =&gt; {
<a href=#119 id=119 data-nosnippet>119</a>/// // Socket is not ready anymore, stop reading
<a href=#120 id=120 data-nosnippet>120</a>/// break;
<a href=#121 id=121 data-nosnippet>121</a>/// }
<a href=#122 id=122 data-nosnippet>122</a>/// e =&gt; panic!("err={:?}", e), // Unexpected error
<a href=#123 id=123 data-nosnippet>123</a>/// }
<a href=#124 id=124 data-nosnippet>124</a>/// }
<a href=#125 id=125 data-nosnippet>125</a>/// }
<a href=#126 id=126 data-nosnippet>126</a>/// }
<a href=#127 id=127 data-nosnippet>127</a>/// }
<a href=#128 id=128 data-nosnippet>128</a>/// }
<a href=#129 id=129 data-nosnippet>129</a>/// # }
<a href=#130 id=130 data-nosnippet>130</a>/// ```
<a href=#131 id=131 data-nosnippet>131</a></span><span class="attr">#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
<a href=#132 id=132 data-nosnippet>132</a></span><span class="kw">pub struct </span>Token(<span class="kw">pub </span>usize);
<a href=#133 id=133 data-nosnippet>133</a>
<a href=#134 id=134 data-nosnippet>134</a><span class="kw">impl </span>From&lt;Token&gt; <span class="kw">for </span>usize {
<a href=#135 id=135 data-nosnippet>135</a> <span class="kw">fn </span>from(val: Token) -&gt; usize {
<a href=#136 id=136 data-nosnippet>136</a> val.<span class="number">0
<a href=#137 id=137 data-nosnippet>137</a> </span>}
<a href=#138 id=138 data-nosnippet>138</a>}
</code></pre></div></section></main></body></html>
+97
View File
@@ -0,0 +1,97 @@
<!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 `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/mio-1.1.1/src/waker.rs`."><title>waker.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mio/</div>waker.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="kw">use crate</span>::{sys, Registry, Token};
<a href=#2 id=2 data-nosnippet>2</a>
<a href=#3 id=3 data-nosnippet>3</a><span class="kw">use </span>std::io;
<a href=#4 id=4 data-nosnippet>4</a>
<a href=#5 id=5 data-nosnippet>5</a><span class="doccomment">/// Waker allows cross-thread waking of [`Poll`].
<a href=#6 id=6 data-nosnippet>6</a>///
<a href=#7 id=7 data-nosnippet>7</a>/// When created it will cause events with [`readable`] readiness and the
<a href=#8 id=8 data-nosnippet>8</a>/// provided `token` if [`wake`] is called, possibly from another thread.
<a href=#9 id=9 data-nosnippet>9</a>///
<a href=#10 id=10 data-nosnippet>10</a>/// [`Poll`]: struct.Poll.html
<a href=#11 id=11 data-nosnippet>11</a>/// [`readable`]: ./event/struct.Event.html#method.is_readable
<a href=#12 id=12 data-nosnippet>12</a>/// [`wake`]: struct.Waker.html#method.wake
<a href=#13 id=13 data-nosnippet>13</a>///
<a href=#14 id=14 data-nosnippet>14</a>/// # Notes
<a href=#15 id=15 data-nosnippet>15</a>///
<a href=#16 id=16 data-nosnippet>16</a>/// `Waker` events are only guaranteed to be delivered while the `Waker` value
<a href=#17 id=17 data-nosnippet>17</a>/// is alive.
<a href=#18 id=18 data-nosnippet>18</a>///
<a href=#19 id=19 data-nosnippet>19</a>/// Only a single `Waker` can be active per [`Poll`], if multiple threads need
<a href=#20 id=20 data-nosnippet>20</a>/// access to the `Waker` it can be shared via for example an `Arc`. What
<a href=#21 id=21 data-nosnippet>21</a>/// happens if multiple `Waker`s are registered with the same `Poll` is
<a href=#22 id=22 data-nosnippet>22</a>/// unspecified.
<a href=#23 id=23 data-nosnippet>23</a>///
<a href=#24 id=24 data-nosnippet>24</a>/// # Implementation notes
<a href=#25 id=25 data-nosnippet>25</a>///
<a href=#26 id=26 data-nosnippet>26</a>/// On platforms that support kqueue this will use the `EVFILT_USER` event
<a href=#27 id=27 data-nosnippet>27</a>/// filter, see [implementation notes of `Poll`] to see what platforms support
<a href=#28 id=28 data-nosnippet>28</a>/// kqueue. On Linux it uses [eventfd].
<a href=#29 id=29 data-nosnippet>29</a>///
<a href=#30 id=30 data-nosnippet>30</a>/// [implementation notes of `Poll`]: struct.Poll.html#implementation-notes
<a href=#31 id=31 data-nosnippet>31</a>/// [eventfd]: https://man7.org/linux/man-pages/man2/eventfd.2.html
<a href=#32 id=32 data-nosnippet>32</a>///
<a href=#33 id=33 data-nosnippet>33</a>/// # Examples
<a href=#34 id=34 data-nosnippet>34</a>///
<a href=#35 id=35 data-nosnippet>35</a>/// Wake a [`Poll`] instance from another thread.
<a href=#36 id=36 data-nosnippet>36</a>///
<a href=#37 id=37 data-nosnippet>37</a></span><span class="attr">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)]
<a href=#38 id=38 data-nosnippet>38</a>#[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)]
<a href=#39 id=39 data-nosnippet>39</a></span><span class="doccomment">/// # fn main() -&gt; Result&lt;(), Box&lt;dyn std::error::Error&gt;&gt; {
<a href=#40 id=40 data-nosnippet>40</a>/// use std::thread;
<a href=#41 id=41 data-nosnippet>41</a>/// use std::time::Duration;
<a href=#42 id=42 data-nosnippet>42</a>/// use std::sync::Arc;
<a href=#43 id=43 data-nosnippet>43</a>///
<a href=#44 id=44 data-nosnippet>44</a>/// use mio::{Events, Token, Poll, Waker};
<a href=#45 id=45 data-nosnippet>45</a>///
<a href=#46 id=46 data-nosnippet>46</a>/// const WAKE_TOKEN: Token = Token(10);
<a href=#47 id=47 data-nosnippet>47</a>///
<a href=#48 id=48 data-nosnippet>48</a>/// let mut poll = Poll::new()?;
<a href=#49 id=49 data-nosnippet>49</a>/// let mut events = Events::with_capacity(2);
<a href=#50 id=50 data-nosnippet>50</a>///
<a href=#51 id=51 data-nosnippet>51</a>/// let waker = Arc::new(Waker::new(poll.registry(), WAKE_TOKEN)?);
<a href=#52 id=52 data-nosnippet>52</a>///
<a href=#53 id=53 data-nosnippet>53</a>/// // We need to keep the Waker alive, so we'll create a clone for the
<a href=#54 id=54 data-nosnippet>54</a>/// // thread we create below.
<a href=#55 id=55 data-nosnippet>55</a>/// let waker1 = waker.clone();
<a href=#56 id=56 data-nosnippet>56</a>/// let handle = thread::spawn(move || {
<a href=#57 id=57 data-nosnippet>57</a>/// // Working hard, or hardly working?
<a href=#58 id=58 data-nosnippet>58</a>/// thread::sleep(Duration::from_millis(500));
<a href=#59 id=59 data-nosnippet>59</a>///
<a href=#60 id=60 data-nosnippet>60</a>/// // Now we'll wake the queue on the other thread.
<a href=#61 id=61 data-nosnippet>61</a>/// waker1.wake().expect("unable to wake");
<a href=#62 id=62 data-nosnippet>62</a>/// });
<a href=#63 id=63 data-nosnippet>63</a>///
<a href=#64 id=64 data-nosnippet>64</a>/// // On our current thread we'll poll for events, without a timeout.
<a href=#65 id=65 data-nosnippet>65</a>/// poll.poll(&amp;mut events, None)?;
<a href=#66 id=66 data-nosnippet>66</a>///
<a href=#67 id=67 data-nosnippet>67</a>/// // After about 500 milliseconds we should be awoken by the other thread and
<a href=#68 id=68 data-nosnippet>68</a>/// // get a single event.
<a href=#69 id=69 data-nosnippet>69</a>/// assert!(!events.is_empty());
<a href=#70 id=70 data-nosnippet>70</a>/// let waker_event = events.iter().next().unwrap();
<a href=#71 id=71 data-nosnippet>71</a>/// assert!(waker_event.is_readable());
<a href=#72 id=72 data-nosnippet>72</a>/// assert_eq!(waker_event.token(), WAKE_TOKEN);
<a href=#73 id=73 data-nosnippet>73</a>/// # handle.join().unwrap();
<a href=#74 id=74 data-nosnippet>74</a>/// # Ok(())
<a href=#75 id=75 data-nosnippet>75</a>/// # }
<a href=#76 id=76 data-nosnippet>76</a>/// ```
<a href=#77 id=77 data-nosnippet>77</a></span><span class="attr">#[derive(Debug)]
<a href=#78 id=78 data-nosnippet>78</a></span><span class="kw">pub struct </span>Waker {
<a href=#79 id=79 data-nosnippet>79</a> inner: sys::Waker,
<a href=#80 id=80 data-nosnippet>80</a>}
<a href=#81 id=81 data-nosnippet>81</a>
<a href=#82 id=82 data-nosnippet>82</a><span class="kw">impl </span>Waker {
<a href=#83 id=83 data-nosnippet>83</a> <span class="doccomment">/// Create a new `Waker`.
<a href=#84 id=84 data-nosnippet>84</a> </span><span class="kw">pub fn </span>new(registry: <span class="kw-2">&amp;</span>Registry, token: Token) -&gt; io::Result&lt;Waker&gt; {
<a href=#85 id=85 data-nosnippet>85</a> <span class="attr">#[cfg(debug_assertions)]
<a href=#86 id=86 data-nosnippet>86</a> </span>registry.register_waker();
<a href=#87 id=87 data-nosnippet>87</a> sys::Waker::new(registry.selector(), token).map(|inner| Waker { inner })
<a href=#88 id=88 data-nosnippet>88</a> }
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a> <span class="doccomment">/// Wake up the [`Poll`] associated with this `Waker`.
<a href=#91 id=91 data-nosnippet>91</a> ///
<a href=#92 id=92 data-nosnippet>92</a> /// [`Poll`]: struct.Poll.html
<a href=#93 id=93 data-nosnippet>93</a> </span><span class="kw">pub fn </span>wake(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<a href=#94 id=94 data-nosnippet>94</a> <span class="self">self</span>.inner.wake()
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a>}
</code></pre></div></section></main></body></html>