| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tokio-1.28.2/src/fs/open_options.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>open_options.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tokio/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::fs::{asyncify, File}; |
| |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::path::Path; |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>mock_open_options; |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">use </span>mock_open_options::MockOpenOptions <span class="kw">as </span>StdOpenOptions; |
| <span class="attribute">#[cfg(not(test))] |
| </span><span class="kw">use </span>std::fs::OpenOptions <span class="kw">as </span>StdOpenOptions; |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">use </span>std::os::unix::fs::OpenOptionsExt; |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">use </span>std::os::windows::fs::OpenOptionsExt; |
| |
| <span class="doccomment">/// Options and flags which can be used to configure how a file is opened. |
| /// |
| /// This builder exposes the ability to configure how a [`File`] is opened and |
| /// what operations are permitted on the open file. The [`File::open`] and |
| /// [`File::create`] methods are aliases for commonly used options using this |
| /// builder. |
| /// |
| /// Generally speaking, when using `OpenOptions`, you'll first call [`new`], |
| /// then chain calls to methods to set each option, then call [`open`], passing |
| /// the path of the file you're trying to open. This will give you a |
| /// [`io::Result`][result] with a [`File`] inside that you can further operate |
| /// on. |
| /// |
| /// This is a specialized version of [`std::fs::OpenOptions`] for usage from |
| /// the Tokio runtime. |
| /// |
| /// `From<std::fs::OpenOptions>` is implemented for more advanced configuration |
| /// than the methods provided here. |
| /// |
| /// [`new`]: OpenOptions::new |
| /// [`open`]: OpenOptions::open |
| /// [result]: std::io::Result |
| /// [`File`]: File |
| /// [`File::open`]: File::open |
| /// [`File::create`]: File::create |
| /// [`std::fs::OpenOptions`]: std::fs::OpenOptions |
| /// |
| /// # Examples |
| /// |
| /// Opening a file to read: |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .read(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// Opening a file for both reading and writing, as well as creating it if it |
| /// doesn't exist: |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .read(true) |
| /// .write(true) |
| /// .create(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="attribute">#[derive(Clone, Debug)] |
| </span><span class="kw">pub struct </span>OpenOptions(StdOpenOptions); |
| |
| <span class="kw">impl </span>OpenOptions { |
| <span class="doccomment">/// Creates a blank new set of options ready for configuration. |
| /// |
| /// All options are initially set to `false`. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::new`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::new |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// |
| /// let mut options = OpenOptions::new(); |
| /// let future = options.read(true).open("foo.txt"); |
| /// ``` |
| </span><span class="kw">pub fn </span>new() -> OpenOptions { |
| OpenOptions(StdOpenOptions::new()) |
| } |
| |
| <span class="doccomment">/// Sets the option for read access. |
| /// |
| /// This option, when true, will indicate that the file should be |
| /// `read`-able if opened. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::read`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::read |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .read(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>read(<span class="kw-2">&mut </span><span class="self">self</span>, read: bool) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.<span class="number">0</span>.read(read); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the option for write access. |
| /// |
| /// This option, when true, will indicate that the file should be |
| /// `write`-able if opened. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::write`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::write |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .write(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, write: bool) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.<span class="number">0</span>.write(write); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the option for the append mode. |
| /// |
| /// This option, when true, means that writes will append to a file instead |
| /// of overwriting previous contents. Note that setting |
| /// `.write(true).append(true)` has the same effect as setting only |
| /// `.append(true)`. |
| /// |
| /// For most filesystems, the operating system guarantees that all writes are |
| /// atomic: no writes get mangled because another process writes at the same |
| /// time. |
| /// |
| /// One maybe obvious note when using append-mode: make sure that all data |
| /// that belongs together is written to the file in one operation. This |
| /// can be done by concatenating strings before passing them to [`write()`], |
| /// or using a buffered writer (with a buffer of adequate size), |
| /// and calling [`flush()`] when the message is complete. |
| /// |
| /// If a file is opened with both read and append access, beware that after |
| /// opening, and after every write, the position for reading may be set at the |
| /// end of the file. So, before writing, save the current position (using |
| /// [`seek`]`(`[`SeekFrom`]`::`[`Current`]`(0))`), and restore it before the next read. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::append`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::append |
| /// |
| /// ## Note |
| /// |
| /// This function doesn't create the file if it doesn't exist. Use the [`create`] |
| /// method to do so. |
| /// |
| /// [`write()`]: crate::io::AsyncWriteExt::write |
| /// [`flush()`]: crate::io::AsyncWriteExt::flush |
| /// [`seek`]: crate::io::AsyncSeekExt::seek |
| /// [`SeekFrom`]: std::io::SeekFrom |
| /// [`Current`]: std::io::SeekFrom::Current |
| /// [`create`]: OpenOptions::create |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .append(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>append(<span class="kw-2">&mut </span><span class="self">self</span>, append: bool) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.<span class="number">0</span>.append(append); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the option for truncating a previous file. |
| /// |
| /// If a file is successfully opened with this option set it will truncate |
| /// the file to 0 length if it already exists. |
| /// |
| /// The file must be opened with write access for truncate to work. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::truncate`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::truncate |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .write(true) |
| /// .truncate(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>truncate(<span class="kw-2">&mut </span><span class="self">self</span>, truncate: bool) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.<span class="number">0</span>.truncate(truncate); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the option for creating a new file. |
| /// |
| /// This option indicates whether a new file will be created if the file |
| /// does not yet already exist. |
| /// |
| /// In order for the file to be created, [`write`] or [`append`] access must |
| /// be used. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::create`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::create |
| /// [`write`]: OpenOptions::write |
| /// [`append`]: OpenOptions::append |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .write(true) |
| /// .create(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>create(<span class="kw-2">&mut </span><span class="self">self</span>, create: bool) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.<span class="number">0</span>.create(create); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the option to always create a new file. |
| /// |
| /// This option indicates whether a new file will be created. No file is |
| /// allowed to exist at the target location, also no (dangling) symlink. |
| /// |
| /// This option is useful because it is atomic. Otherwise between checking |
| /// whether a file exists and creating a new one, the file may have been |
| /// created by another process (a TOCTOU race condition / attack). |
| /// |
| /// If `.create_new(true)` is set, [`.create()`] and [`.truncate()`] are |
| /// ignored. |
| /// |
| /// The file must be opened with write or append access in order to create a |
| /// new file. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::create_new`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::create_new |
| /// [`.create()`]: OpenOptions::create |
| /// [`.truncate()`]: OpenOptions::truncate |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .write(true) |
| /// .create_new(true) |
| /// .open("foo.txt") |
| /// .await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>create_new(<span class="kw-2">&mut </span><span class="self">self</span>, create_new: bool) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.<span class="number">0</span>.create_new(create_new); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Opens a file at `path` with the options specified by `self`. |
| /// |
| /// This is an async version of [`std::fs::OpenOptions::open`][std] |
| /// |
| /// [std]: std::fs::OpenOptions::open |
| /// |
| /// # Errors |
| /// |
| /// This function will return an error under a number of different |
| /// circumstances. Some of these error conditions are listed here, together |
| /// with their [`ErrorKind`]. The mapping to [`ErrorKind`]s is not part of |
| /// the compatibility contract of the function, especially the `Other` kind |
| /// might change to more specific kinds in the future. |
| /// |
| /// * [`NotFound`]: The specified file does not exist and neither `create` |
| /// or `create_new` is set. |
| /// * [`NotFound`]: One of the directory components of the file path does |
| /// not exist. |
| /// * [`PermissionDenied`]: The user lacks permission to get the specified |
| /// access rights for the file. |
| /// * [`PermissionDenied`]: The user lacks permission to open one of the |
| /// directory components of the specified path. |
| /// * [`AlreadyExists`]: `create_new` was specified and the file already |
| /// exists. |
| /// * [`InvalidInput`]: Invalid combinations of open options (truncate |
| /// without write access, no access mode set, etc.). |
| /// * [`Other`]: One of the directory components of the specified file path |
| /// was not, in fact, a directory. |
| /// * [`Other`]: Filesystem-level errors: full disk, write permission |
| /// requested on a read-only file system, exceeded disk quota, too many |
| /// open files, too long filename, too many symbolic links in the |
| /// specified path (Unix-like systems only), etc. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let file = OpenOptions::new().open("foo.txt").await?; |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// [`ErrorKind`]: std::io::ErrorKind |
| /// [`AlreadyExists`]: std::io::ErrorKind::AlreadyExists |
| /// [`InvalidInput`]: std::io::ErrorKind::InvalidInput |
| /// [`NotFound`]: std::io::ErrorKind::NotFound |
| /// [`Other`]: std::io::ErrorKind::Other |
| /// [`PermissionDenied`]: std::io::ErrorKind::PermissionDenied |
| </span><span class="kw">pub async fn </span>open(<span class="kw-2">&</span><span class="self">self</span>, path: <span class="kw">impl </span>AsRef<Path>) -> io::Result<File> { |
| <span class="kw">let </span>path = path.as_ref().to_owned(); |
| <span class="kw">let </span>opts = <span class="self">self</span>.<span class="number">0</span>.clone(); |
| |
| <span class="kw">let </span>std = asyncify(<span class="kw">move </span>|| opts.open(path)).<span class="kw">await</span><span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(File::from_std(std)) |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to the underlying `std::fs::OpenOptions` |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>as_inner_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>StdOpenOptions { |
| <span class="kw-2">&mut </span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![unix] |
| |
| </span><span class="kw">impl </span>OpenOptions { |
| <span class="doccomment">/// Sets the mode bits that a new file will be created with. |
| /// |
| /// If a new file is created as part of an `OpenOptions::open` call then this |
| /// specified `mode` will be used as the permission bits for the new file. |
| /// If no `mode` is set, the default of `0o666` will be used. |
| /// The operating system masks out bits with the system's `umask`, to produce |
| /// the final permissions. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let mut options = OpenOptions::new(); |
| /// options.mode(0o644); // Give read/write for owner and read for others. |
| /// let file = options.open("foo.txt").await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>mode(<span class="kw-2">&mut </span><span class="self">self</span>, mode: u32) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.as_inner_mut().mode(mode); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Passes custom flags to the `flags` argument of `open`. |
| /// |
| /// The bits that define the access mode are masked out with `O_ACCMODE`, to |
| /// ensure they do not interfere with the access mode set by Rusts options. |
| /// |
| /// Custom flags can only set flags, not remove flags set by Rusts options. |
| /// This options overwrites any previously set custom flags. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use libc; |
| /// use tokio::fs::OpenOptions; |
| /// use std::io; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let mut options = OpenOptions::new(); |
| /// options.write(true); |
| /// if cfg!(unix) { |
| /// options.custom_flags(libc::O_NOFOLLOW); |
| /// } |
| /// let file = options.open("foo.txt").await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>custom_flags(<span class="kw-2">&mut </span><span class="self">self</span>, flags: i32) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.as_inner_mut().custom_flags(flags); |
| <span class="self">self |
| </span>} |
| } |
| } |
| |
| <span class="macro">cfg_windows! </span>{ |
| <span class="kw">impl </span>OpenOptions { |
| <span class="doccomment">/// Overrides the `dwDesiredAccess` argument to the call to [`CreateFile`] |
| /// with the specified value. |
| /// |
| /// This will override the `read`, `write`, and `append` flags on the |
| /// `OpenOptions` structure. This method provides fine-grained control over |
| /// the permissions to read, write and append data, attributes (like hidden |
| /// and system), and extended attributes. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> std::io::Result<()> { |
| /// // Open without read and write permission, for example if you only need |
| /// // to call `stat` on the file |
| /// let file = OpenOptions::new().access_mode(0).open("foo.txt").await?; |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea |
| </span><span class="kw">pub fn </span>access_mode(<span class="kw-2">&mut </span><span class="self">self</span>, access: u32) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.as_inner_mut().access_mode(access); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Overrides the `dwShareMode` argument to the call to [`CreateFile`] with |
| /// the specified value. |
| /// |
| /// By default `share_mode` is set to |
| /// `FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE`. This allows |
| /// other processes to read, write, and delete/rename the same file |
| /// while it is open. Removing any of the flags will prevent other |
| /// processes from performing the corresponding operation until the file |
| /// handle is closed. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::fs::OpenOptions; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> std::io::Result<()> { |
| /// // Do not allow others to read or modify this file while we have it open |
| /// // for writing. |
| /// let file = OpenOptions::new() |
| /// .write(true) |
| /// .share_mode(0) |
| /// .open("foo.txt").await?; |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea |
| </span><span class="kw">pub fn </span>share_mode(<span class="kw-2">&mut </span><span class="self">self</span>, share: u32) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.as_inner_mut().share_mode(share); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets extra flags for the `dwFileFlags` argument to the call to |
| /// [`CreateFile2`] to the specified value (or combines it with |
| /// `attributes` and `security_qos_flags` to set the `dwFlagsAndAttributes` |
| /// for [`CreateFile`]). |
| /// |
| /// Custom flags can only set flags, not remove flags set by Rust's options. |
| /// This option overwrites any previously set custom flags. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use windows_sys::Win32::Storage::FileSystem::FILE_FLAG_DELETE_ON_CLOSE; |
| /// use tokio::fs::OpenOptions; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> std::io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .create(true) |
| /// .write(true) |
| /// .custom_flags(FILE_FLAG_DELETE_ON_CLOSE) |
| /// .open("foo.txt").await?; |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea |
| /// [`CreateFile2`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfile2 |
| </span><span class="kw">pub fn </span>custom_flags(<span class="kw-2">&mut </span><span class="self">self</span>, flags: u32) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.as_inner_mut().custom_flags(flags); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the `dwFileAttributes` argument to the call to [`CreateFile2`] to |
| /// the specified value (or combines it with `custom_flags` and |
| /// `security_qos_flags` to set the `dwFlagsAndAttributes` for |
| /// [`CreateFile`]). |
| /// |
| /// If a _new_ file is created because it does not yet exist and |
| /// `.create(true)` or `.create_new(true)` are specified, the new file is |
| /// given the attributes declared with `.attributes()`. |
| /// |
| /// If an _existing_ file is opened with `.create(true).truncate(true)`, its |
| /// existing attributes are preserved and combined with the ones declared |
| /// with `.attributes()`. |
| /// |
| /// In all other cases the attributes get ignored. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use windows_sys::Win32::Storage::FileSystem::FILE_ATTRIBUTE_HIDDEN; |
| /// use tokio::fs::OpenOptions; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> std::io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .write(true) |
| /// .create(true) |
| /// .attributes(FILE_ATTRIBUTE_HIDDEN) |
| /// .open("foo.txt").await?; |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea |
| /// [`CreateFile2`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfile2 |
| </span><span class="kw">pub fn </span>attributes(<span class="kw-2">&mut </span><span class="self">self</span>, attributes: u32) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.as_inner_mut().attributes(attributes); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Sets the `dwSecurityQosFlags` argument to the call to [`CreateFile2`] to |
| /// the specified value (or combines it with `custom_flags` and `attributes` |
| /// to set the `dwFlagsAndAttributes` for [`CreateFile`]). |
| /// |
| /// By default `security_qos_flags` is not set. It should be specified when |
| /// opening a named pipe, to control to which degree a server process can |
| /// act on behalf of a client process (security impersonation level). |
| /// |
| /// When `security_qos_flags` is not set, a malicious program can gain the |
| /// elevated privileges of a privileged Rust process when it allows opening |
| /// user-specified paths, by tricking it into opening a named pipe. So |
| /// arguably `security_qos_flags` should also be set when opening arbitrary |
| /// paths. However the bits can then conflict with other flags, specifically |
| /// `FILE_FLAG_OPEN_NO_RECALL`. |
| /// |
| /// For information about possible values, see [Impersonation Levels] on the |
| /// Windows Dev Center site. The `SECURITY_SQOS_PRESENT` flag is set |
| /// automatically when using this method. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use windows_sys::Win32::Storage::FileSystem::SECURITY_IDENTIFICATION; |
| /// use tokio::fs::OpenOptions; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() -> std::io::Result<()> { |
| /// let file = OpenOptions::new() |
| /// .write(true) |
| /// .create(true) |
| /// |
| /// // Sets the flag value to `SecurityIdentification`. |
| /// .security_qos_flags(SECURITY_IDENTIFICATION) |
| /// |
| /// .open(r"\\.\pipe\MyPipe").await?; |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| /// |
| /// [`CreateFile`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea |
| /// [`CreateFile2`]: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfile2 |
| /// [Impersonation Levels]: |
| /// https://docs.microsoft.com/en-us/windows/win32/api/winnt/ne-winnt-security_impersonation_level |
| </span><span class="kw">pub fn </span>security_qos_flags(<span class="kw-2">&mut </span><span class="self">self</span>, flags: u32) -> <span class="kw-2">&mut </span>OpenOptions { |
| <span class="self">self</span>.as_inner_mut().security_qos_flags(flags); |
| <span class="self">self |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl </span>From<StdOpenOptions> <span class="kw">for </span>OpenOptions { |
| <span class="kw">fn </span>from(options: StdOpenOptions) -> OpenOptions { |
| OpenOptions(options) |
| } |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>OpenOptions { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::new() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
