blob: 1551ea4d29d966d4cc8e85f9b65f7823c365e6b3 [file] [log] [blame]
<!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/sunhe/incubator-teaclave/third_party/rust-sgx-sdk/sgx_protected_fs/tfs/src/fs.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>fs.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="../../sgx_tprotected_fs/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="../../sgx_tprotected_fs/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>
</pre><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// &quot;License&quot;); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License..
</span><span class="kw">use </span><span class="kw">crate</span>::sys <span class="kw">as </span>fs_imp;
<span class="kw">use </span>sgx_types::types::{Key128bit, Mac128bit};
<span class="kw">use </span>std::io::{<span class="self">self</span>, Read, Seek, SeekFrom, Write};
<span class="kw">use </span>std::os::unix::fs::FileExt;
<span class="kw">use </span>std::path::Path;
<span class="kw">use </span>std::string::String;
<span class="kw">use </span>std::vec::Vec;
<span class="macro">cfg_if! </span>{
<span class="kw">if </span><span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)] </span>{
<span class="kw">use </span>sgx_rsrvmm::map::Map;
<span class="kw">use </span>sgx_types::error::errno::ESGX;
<span class="kw">use </span>sgx_types::error::OsResult;
<span class="kw">use </span>sgx_types::types::KeyPolicy;
}
}
<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 SgxFile is opened and
/// what operations are permitted on the open file. The SgxFile::open and
/// SgxFile::create methods are aliases for commonly used options using this
/// builder.
///
</span><span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>OpenOptions(fs_imp::OpenOptions);
<span class="attribute">#[derive(Clone, Debug)]
</span><span class="kw">pub struct </span>EncryptMode(fs_imp::EncryptMode);
<span class="doccomment">/// A reference to an open Sgxfile on the filesystem.
///
/// An instance of a `SgxFile` can be read and/or written depending on what options
/// it was opened with. SgxFiles also implement [`Seek`] to alter the logical cursor
/// that the file contains internally.
///
/// SgxFiles are automatically closed when they go out of scope.
</span><span class="kw">pub struct </span>SgxFile {
inner: fs_imp::SgxFile,
}
<span class="doccomment">/// Read the entire contents of a file into a bytes vector.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>read&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;Vec&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>file = SgxFile::open(path)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>bytes = Vec::with_capacity(buffer_capacity_required(<span class="kw-2">&amp;</span>file));
file.read_to_end(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(bytes)
}
<span class="doccomment">/// Read the entire contents of a file into a string.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>read_to_string&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;String&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>file = SgxFile::open(path)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>string = String::with_capacity(buffer_capacity_required(<span class="kw-2">&amp;</span>file));
file.read_to_string(<span class="kw-2">&amp;mut </span>string)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(string)
}
<span class="doccomment">/// Write a slice as the entire contents of a file.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>write&lt;P: AsRef&lt;Path&gt;, C: AsRef&lt;[u8]&gt;&gt;(path: P, contents: C) -&gt; io::Result&lt;()&gt; {
SgxFile::create(path)<span class="question-mark">?</span>.write_all(contents.as_ref())
}
<span class="kw">pub fn </span>read_with_key&lt;P: AsRef&lt;Path&gt;&gt;(path: P, key: Key128bit) -&gt; io::Result&lt;Vec&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>file = SgxFile::open_with_key(path, key)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>bytes = Vec::with_capacity(buffer_capacity_required(<span class="kw-2">&amp;</span>file));
file.read_to_end(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(bytes)
}
<span class="kw">pub fn </span>read_to_string_with_key&lt;P: AsRef&lt;Path&gt;&gt;(path: P, key: Key128bit) -&gt; io::Result&lt;String&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>file = SgxFile::open_with_key(path, key)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>string = String::with_capacity(buffer_capacity_required(<span class="kw-2">&amp;</span>file));
file.read_to_string(<span class="kw-2">&amp;mut </span>string)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(string)
}
<span class="kw">pub fn </span>write_with_key&lt;P: AsRef&lt;Path&gt;, C: AsRef&lt;[u8]&gt;&gt;(
path: P,
key: Key128bit,
contents: C,
) -&gt; io::Result&lt;()&gt; {
SgxFile::create_with_key(path, key)<span class="question-mark">?</span>.write_all(contents.as_ref())
}
<span class="kw">pub fn </span>read_integrity_only&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;Vec&lt;u8&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>file = SgxFile::open_integrity_only(path)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>bytes = Vec::with_capacity(buffer_capacity_required(<span class="kw-2">&amp;</span>file));
file.read_to_end(<span class="kw-2">&amp;mut </span>bytes)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(bytes)
}
<span class="kw">pub fn </span>read_to_string_integrity_only&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;String&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>file = SgxFile::open_integrity_only(path)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>string = String::with_capacity(buffer_capacity_required(<span class="kw-2">&amp;</span>file));
file.read_to_string(<span class="kw-2">&amp;mut </span>string)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(string)
}
<span class="kw">pub fn </span>write_integrity_only&lt;P: AsRef&lt;Path&gt;, C: AsRef&lt;[u8]&gt;&gt;(
path: P,
contents: C,
) -&gt; io::Result&lt;()&gt; {
SgxFile::create_integrity_only(path)<span class="question-mark">?</span>.write_all(contents.as_ref())
}
<span class="kw">impl </span>SgxFile {
<span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>open&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new().read(<span class="bool-val">true</span>).open(path.as_ref())
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>create&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new().write(<span class="bool-val">true</span>).open(path.as_ref())
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>append&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new().append(<span class="bool-val">true</span>).open(path.as_ref())
}
<span class="kw">pub fn </span>open_with_key&lt;P: AsRef&lt;Path&gt;&gt;(path: P, key: Key128bit) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.read(<span class="bool-val">true</span>)
.open_with_key(path.as_ref(), key)
}
<span class="kw">pub fn </span>create_with_key&lt;P: AsRef&lt;Path&gt;&gt;(path: P, key: Key128bit) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.write(<span class="bool-val">true</span>)
.open_with_key(path.as_ref(), key)
}
<span class="kw">pub fn </span>append_with_key&lt;P: AsRef&lt;Path&gt;&gt;(path: P, key: Key128bit) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.append(<span class="bool-val">true</span>)
.open_with_key(path.as_ref(), key)
}
<span class="kw">pub fn </span>open_integrity_only&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.read(<span class="bool-val">true</span>)
.open_integrity_only(path.as_ref())
}
<span class="kw">pub fn </span>create_integrity_only&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.write(<span class="bool-val">true</span>)
.open_integrity_only(path.as_ref())
}
<span class="kw">pub fn </span>append_integrity_only&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.append(<span class="bool-val">true</span>)
.open_integrity_only(path.as_ref())
}
<span class="kw">pub fn </span>open_with&lt;P: AsRef&lt;Path&gt;&gt;(
path: P,
encrypt_mode: EncryptMode,
cache_size: <span class="prelude-ty">Option</span>&lt;usize&gt;,
) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.read(<span class="bool-val">true</span>)
.open_with(path.as_ref(), encrypt_mode, cache_size)
}
<span class="kw">pub fn </span>create_with&lt;P: AsRef&lt;Path&gt;&gt;(
path: P,
encrypt_mode: EncryptMode,
cache_size: <span class="prelude-ty">Option</span>&lt;usize&gt;,
) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.write(<span class="bool-val">true</span>)
.open_with(path.as_ref(), encrypt_mode, cache_size)
}
<span class="kw">pub fn </span>append_with&lt;P: AsRef&lt;Path&gt;&gt;(
path: P,
encrypt_mode: EncryptMode,
cache_size: <span class="prelude-ty">Option</span>&lt;usize&gt;,
) -&gt; io::Result&lt;SgxFile&gt; {
OpenOptions::new()
.append(<span class="bool-val">true</span>)
.open_with(path.as_ref(), encrypt_mode, cache_size)
}
<span class="kw">pub fn </span>options() -&gt; OpenOptions {
OpenOptions::new()
}
<span class="kw">pub fn </span>set_len(<span class="kw-2">&amp;</span><span class="self">self</span>, size: u64) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.inner.set_len(size)
}
<span class="kw">pub fn </span>tell(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;u64&gt; {
<span class="self">self</span>.inner.tell()
}
<span class="kw">pub fn </span>file_size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;u64&gt; {
<span class="self">self</span>.inner.file_size()
}
<span class="kw">pub fn </span>is_eof(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.inner.is_eof()
}
<span class="kw">pub fn </span>clear_error(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.inner.clear_error()
}
<span class="kw">pub fn </span>clear_cache(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.inner.clear_cache()
}
<span class="kw">pub fn </span>get_mac(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;Mac128bit&gt; {
<span class="self">self</span>.inner.get_mac()
}
<span class="kw">pub fn </span>rename&lt;P: AsRef&lt;str&gt;&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, old_name: P, new_name: P) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.inner.rename(old_name.as_ref(), new_name.as_ref())
}
}
<span class="doccomment">/// Indicates how much extra capacity is needed to read the rest of the file.
</span><span class="kw">fn </span>buffer_capacity_required(file: <span class="kw-2">&amp;</span>SgxFile) -&gt; usize {
<span class="kw">let </span>size = file.file_size().unwrap_or(<span class="number">0</span>);
<span class="kw">let </span>pos = file.tell().unwrap_or(<span class="number">0</span>);
<span class="comment">// Don&#39;t worry about `usize` overflow because reading will fail regardless
// in that case.
</span>size.saturating_sub(pos) <span class="kw">as </span>usize
}
<span class="kw">impl </span>Read <span class="kw">for </span>SgxFile {
<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; {
<span class="self">self</span>.inner.read(buf)
}
}
<span class="kw">impl </span>Write <span class="kw">for </span>SgxFile {
<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; {
<span class="self">self</span>.inner.write(buf)
}
<span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.inner.flush()
}
}
<span class="kw">impl </span>Seek <span class="kw">for </span>SgxFile {
<span class="kw">fn </span>seek(<span class="kw-2">&amp;mut </span><span class="self">self</span>, pos: SeekFrom) -&gt; io::Result&lt;u64&gt; {
<span class="self">self</span>.inner.seek(pos)
}
}
<span class="kw">impl </span>Read <span class="kw">for </span><span class="kw-2">&amp;</span>SgxFile {
<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; {
<span class="self">self</span>.inner.read(buf)
}
}
<span class="kw">impl </span>Write <span class="kw">for </span><span class="kw-2">&amp;</span>SgxFile {
<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; {
<span class="self">self</span>.inner.write(buf)
}
<span class="kw">fn </span>flush(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.inner.flush()
}
}
<span class="kw">impl </span>Seek <span class="kw">for </span><span class="kw-2">&amp;</span>SgxFile {
<span class="kw">fn </span>seek(<span class="kw-2">&amp;mut </span><span class="self">self</span>, pos: SeekFrom) -&gt; io::Result&lt;u64&gt; {
<span class="self">self</span>.inner.seek(pos)
}
}
<span class="kw">impl </span>FileExt <span class="kw">for </span>SgxFile {
<span class="kw">fn </span>read_at(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8], offset: u64) -&gt; io::Result&lt;usize&gt; {
<span class="self">self</span>.inner.read_at(buf, offset)
}
<span class="kw">fn </span>write_at(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8], offset: u64) -&gt; io::Result&lt;usize&gt; {
<span class="self">self</span>.inner.write_at(buf, offset)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">impl </span>Map <span class="kw">for </span>SgxFile {
<span class="kw">fn </span>read_at(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8], offset: usize) -&gt; OsResult&lt;usize&gt; {
<span class="self">self</span>.inner
.read_at(buf, offset <span class="kw">as </span>u64)
.map_err(|e| e.raw_os_error().unwrap_or(ESGX))
}
<span class="kw">fn </span>write_at(<span class="kw-2">&amp;</span><span class="self">self</span>, buf: <span class="kw-2">&amp;</span>[u8], offset: usize) -&gt; OsResult&lt;usize&gt; {
<span class="self">self</span>.inner
.write_at(buf, offset <span class="kw">as </span>u64)
.map_err(|e| e.raw_os_error().unwrap_or(ESGX))
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>flush(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; OsResult {
<span class="self">self</span>.inner
.flush()
.map_err(|e| e.raw_os_error().unwrap_or(ESGX))
}
}
<span class="kw">pub fn </span>remove&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;()&gt; {
fs_imp::remove(path.as_ref())
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>export_key&lt;P: AsRef&lt;Path&gt;&gt;(path: P) -&gt; io::Result&lt;Key128bit&gt; {
fs_imp::export_key(path.as_ref())
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>import_key&lt;P: AsRef&lt;Path&gt;&gt;(
path: P,
key: Key128bit,
key_policy: <span class="prelude-ty">Option</span>&lt;KeyPolicy&gt;,
) -&gt; io::Result&lt;()&gt; {
fs_imp::import_key(path.as_ref(), key, key_policy)
}
<span class="kw">impl </span>OpenOptions {
<span class="doccomment">/// Creates a blank new set of options ready for configuration.
</span><span class="kw">pub fn </span>new() -&gt; OpenOptions {
OpenOptions(fs_imp::OpenOptions::new())
}
<span class="doccomment">/// Sets the option for read access.
</span><span class="kw">pub fn </span>read(<span class="kw-2">&amp;mut </span><span class="self">self</span>, read: bool) -&gt; <span class="kw-2">&amp;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.
</span><span class="kw">pub fn </span>write(<span class="kw-2">&amp;mut </span><span class="self">self</span>, write: bool) -&gt; <span class="kw-2">&amp;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.
</span><span class="kw">pub fn </span>append(<span class="kw-2">&amp;mut </span><span class="self">self</span>, append: bool) -&gt; <span class="kw-2">&amp;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 update a previous file.
</span><span class="kw">pub fn </span>update(<span class="kw-2">&amp;mut </span><span class="self">self</span>, update: bool) -&gt; <span class="kw-2">&amp;mut </span>OpenOptions {
<span class="self">self</span>.<span class="number">0</span>.update(update);
<span class="self">self
</span>}
<span class="doccomment">/// Sets the option for binary a file.
</span><span class="kw">pub fn </span>binary(<span class="kw-2">&amp;mut </span><span class="self">self</span>, binary: bool) -&gt; <span class="kw-2">&amp;mut </span>OpenOptions {
<span class="self">self</span>.<span class="number">0</span>.binary(binary);
<span class="self">self
</span>}
<span class="doccomment">/// Opens a file at `path` with the options specified by `self`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
</span><span class="kw">pub fn </span>open&lt;P: AsRef&lt;Path&gt;&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, path: P) -&gt; io::Result&lt;SgxFile&gt; {
<span class="self">self</span>.open_with(path, EncryptMode::auto_key(<span class="prelude-val">None</span>), <span class="prelude-val">None</span>)
}
<span class="kw">pub fn </span>open_with_key&lt;P: AsRef&lt;Path&gt;&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, path: P, key: Key128bit) -&gt; io::Result&lt;SgxFile&gt; {
<span class="self">self</span>.open_with(path, EncryptMode::user_key(key), <span class="prelude-val">None</span>)
}
<span class="kw">pub fn </span>open_integrity_only&lt;P: AsRef&lt;Path&gt;&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, path: P) -&gt; io::Result&lt;SgxFile&gt; {
<span class="self">self</span>.open_with(path, EncryptMode::integrity_only(), <span class="prelude-val">None</span>)
}
<span class="kw">pub fn </span>open_with&lt;P: AsRef&lt;Path&gt;&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
path: P,
encrypt_mode: EncryptMode,
cache_size: <span class="prelude-ty">Option</span>&lt;usize&gt;,
) -&gt; io::Result&lt;SgxFile&gt; {
<span class="kw">let </span>inner = fs_imp::SgxFile::open(path, <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0</span>, <span class="kw-2">&amp;</span>encrypt_mode.<span class="number">0</span>, cache_size)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(SgxFile { inner })
}
}
<span class="kw">impl </span>Default <span class="kw">for </span>OpenOptions {
<span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::new()
}
}
<span class="kw">impl </span>EncryptMode {
<span class="attribute">#[cfg(feature = <span class="string">&quot;tfs&quot;</span>)]
#[inline]
</span><span class="kw">pub fn </span>auto_key(key_policy: <span class="prelude-ty">Option</span>&lt;KeyPolicy&gt;) -&gt; EncryptMode {
EncryptMode(fs_imp::EncryptMode::EncryptAutoKey(
key_policy.unwrap_or(KeyPolicy::MRSIGNER),
))
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>user_key(key: Key128bit) -&gt; EncryptMode {
EncryptMode(fs_imp::EncryptMode::EncryptUserKey(key))
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>integrity_only() -&gt; EncryptMode {
EncryptMode(fs_imp::EncryptMode::IntegrityOnly)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="sgx_tprotected_fs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>