This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/iceberg-rust.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 3e5af6a8 deploy: 7addc3f54bccf24a68297f9c8980086e4f63f2d0
3e5af6a8 is described below
commit 3e5af6a898bebf55b5e962a5b21b9c90549a7e52
Author: liurenjie1024 <[email protected]>
AuthorDate: Tue Jan 14 02:17:27 2025 +0000
deploy: 7addc3f54bccf24a68297f9c8980086e4f63f2d0
---
api/help.html | 2 +-
api/settings.html | 2 +-
api/src-files.js | 2 +-
api/src/iceberg/puffin/compression.rs.html | 12 +-
api/src/iceberg/puffin/metadata.rs.html | 1555 ++++++++++++++++++++++++++++
api/src/iceberg/puffin/mod.rs.html | 8 +
6 files changed, 1575 insertions(+), 6 deletions(-)
diff --git a/api/help.html b/api/help.html
index f79e7b68..b3855f23 100644
--- a/api/help.html
+++ b/api/help.html
@@ -1 +1 @@
-<!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="Documentation for
Rustdoc"><title>Help</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-5
[...]
\ No newline at end of file
+<!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="Documentation for
Rustdoc"><title>Help</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-5
[...]
\ No newline at end of file
diff --git a/api/settings.html b/api/settings.html
index dfaf9d28..0b4d7eab 100644
--- a/api/settings.html
+++ b/api/settings.html
@@ -1 +1 @@
-<!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="Settings
of
Rustdoc"><title>Settings</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562
[...]
\ No newline at end of file
+<!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="Settings
of
Rustdoc"><title>Settings</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562
[...]
\ No newline at end of file
diff --git a/api/src-files.js b/api/src-files.js
index cd5830a1..4b4f24eb 100644
--- a/api/src-files.js
+++ b/api/src-files.js
@@ -1,5 +1,5 @@
var srcIndex = new Map(JSON.parse('[\
-["iceberg",["",[["arrow",[],["mod.rs","reader.rs","record_batch_projector.rs","record_batch_transformer.rs","schema.rs"]],["avro",[],["mod.rs","schema.rs"]],["catalog",[],["mod.rs"]],["expr",[["visitors",[],["bound_predicate_visitor.rs","expression_evaluator.rs","inclusive_metrics_evaluator.rs","inclusive_projection.rs","manifest_evaluator.rs","mod.rs","page_index_evaluator.rs","row_group_metrics_evaluator.rs"]]],["accessor.rs","mod.rs","predicate.rs","term.rs"]],["inspect",[],["manifest
[...]
+["iceberg",["",[["arrow",[],["mod.rs","reader.rs","record_batch_projector.rs","record_batch_transformer.rs","schema.rs"]],["avro",[],["mod.rs","schema.rs"]],["catalog",[],["mod.rs"]],["expr",[["visitors",[],["bound_predicate_visitor.rs","expression_evaluator.rs","inclusive_metrics_evaluator.rs","inclusive_projection.rs","manifest_evaluator.rs","mod.rs","page_index_evaluator.rs","row_group_metrics_evaluator.rs"]]],["accessor.rs","mod.rs","predicate.rs","term.rs"]],["inspect",[],["manifest
[...]
["iceberg_catalog_glue",["",[],["catalog.rs","error.rs","lib.rs","schema.rs","utils.rs"]]],\
["iceberg_catalog_hms",["",[],["catalog.rs","error.rs","lib.rs","schema.rs","utils.rs"]]],\
["iceberg_catalog_memory",["",[],["catalog.rs","lib.rs","namespace_state.rs"]]],\
diff --git a/api/src/iceberg/puffin/compression.rs.html
b/api/src/iceberg/puffin/compression.rs.html
index f0c3b906..3c469d96 100644
--- a/api/src/iceberg/puffin/compression.rs.html
+++ b/api/src/iceberg/puffin/compression.rs.html
@@ -118,6 +118,9 @@
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
+<a href="#121" id="121">121</a>
+<a href="#122" id="122">122</a>
+<a href="#123" id="123">123</a>
</pre></div><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
@@ -135,10 +138,13 @@
// specific language governing permissions and limitations
// under the License.
-</span><span class="kw">use crate</span>::{Error, ErrorKind, <span
class="prelude-ty">Result</span>};
+</span><span class="kw">use </span>serde::{Deserialize, Serialize};
-<span class="attr">#[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
-</span><span class="doccomment">/// Data compression formats
+<span class="kw">use crate</span>::{Error, ErrorKind, <span
class="prelude-ty">Result</span>};
+
+<span class="doccomment">/// Data compression formats
+</span><span class="attr">#[derive(Debug, PartialEq, Eq, Clone, Copy, Default,
Serialize, Deserialize)]
+#[serde(rename_all = <span class="string">"lowercase"</span>)]
</span><span class="kw">pub enum </span>CompressionCodec {
<span class="attr">#[default]
</span><span class="doccomment">/// No compression
diff --git a/api/src/iceberg/puffin/metadata.rs.html
b/api/src/iceberg/puffin/metadata.rs.html
new file mode 100644
index 00000000..5ffd7123
--- /dev/null
+++ b/api/src/iceberg/puffin/metadata.rs.html
@@ -0,0 +1,1555 @@
+<!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 `crates/iceberg/src/puffin/metadata.rs`."><title>metadata.rs -
source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSan
[...]
+<a href="#2" id="2">2</a>
+<a href="#3" id="3">3</a>
+<a href="#4" id="4">4</a>
+<a href="#5" id="5">5</a>
+<a href="#6" id="6">6</a>
+<a href="#7" id="7">7</a>
+<a href="#8" id="8">8</a>
+<a href="#9" id="9">9</a>
+<a href="#10" id="10">10</a>
+<a href="#11" id="11">11</a>
+<a href="#12" id="12">12</a>
+<a href="#13" id="13">13</a>
+<a href="#14" id="14">14</a>
+<a href="#15" id="15">15</a>
+<a href="#16" id="16">16</a>
+<a href="#17" id="17">17</a>
+<a href="#18" id="18">18</a>
+<a href="#19" id="19">19</a>
+<a href="#20" id="20">20</a>
+<a href="#21" id="21">21</a>
+<a href="#22" id="22">22</a>
+<a href="#23" id="23">23</a>
+<a href="#24" id="24">24</a>
+<a href="#25" id="25">25</a>
+<a href="#26" id="26">26</a>
+<a href="#27" id="27">27</a>
+<a href="#28" id="28">28</a>
+<a href="#29" id="29">29</a>
+<a href="#30" id="30">30</a>
+<a href="#31" id="31">31</a>
+<a href="#32" id="32">32</a>
+<a href="#33" id="33">33</a>
+<a href="#34" id="34">34</a>
+<a href="#35" id="35">35</a>
+<a href="#36" id="36">36</a>
+<a href="#37" id="37">37</a>
+<a href="#38" id="38">38</a>
+<a href="#39" id="39">39</a>
+<a href="#40" id="40">40</a>
+<a href="#41" id="41">41</a>
+<a href="#42" id="42">42</a>
+<a href="#43" id="43">43</a>
+<a href="#44" id="44">44</a>
+<a href="#45" id="45">45</a>
+<a href="#46" id="46">46</a>
+<a href="#47" id="47">47</a>
+<a href="#48" id="48">48</a>
+<a href="#49" id="49">49</a>
+<a href="#50" id="50">50</a>
+<a href="#51" id="51">51</a>
+<a href="#52" id="52">52</a>
+<a href="#53" id="53">53</a>
+<a href="#54" id="54">54</a>
+<a href="#55" id="55">55</a>
+<a href="#56" id="56">56</a>
+<a href="#57" id="57">57</a>
+<a href="#58" id="58">58</a>
+<a href="#59" id="59">59</a>
+<a href="#60" id="60">60</a>
+<a href="#61" id="61">61</a>
+<a href="#62" id="62">62</a>
+<a href="#63" id="63">63</a>
+<a href="#64" id="64">64</a>
+<a href="#65" id="65">65</a>
+<a href="#66" id="66">66</a>
+<a href="#67" id="67">67</a>
+<a href="#68" id="68">68</a>
+<a href="#69" id="69">69</a>
+<a href="#70" id="70">70</a>
+<a href="#71" id="71">71</a>
+<a href="#72" id="72">72</a>
+<a href="#73" id="73">73</a>
+<a href="#74" id="74">74</a>
+<a href="#75" id="75">75</a>
+<a href="#76" id="76">76</a>
+<a href="#77" id="77">77</a>
+<a href="#78" id="78">78</a>
+<a href="#79" id="79">79</a>
+<a href="#80" id="80">80</a>
+<a href="#81" id="81">81</a>
+<a href="#82" id="82">82</a>
+<a href="#83" id="83">83</a>
+<a href="#84" id="84">84</a>
+<a href="#85" id="85">85</a>
+<a href="#86" id="86">86</a>
+<a href="#87" id="87">87</a>
+<a href="#88" id="88">88</a>
+<a href="#89" id="89">89</a>
+<a href="#90" id="90">90</a>
+<a href="#91" id="91">91</a>
+<a href="#92" id="92">92</a>
+<a href="#93" id="93">93</a>
+<a href="#94" id="94">94</a>
+<a href="#95" id="95">95</a>
+<a href="#96" id="96">96</a>
+<a href="#97" id="97">97</a>
+<a href="#98" id="98">98</a>
+<a href="#99" id="99">99</a>
+<a href="#100" id="100">100</a>
+<a href="#101" id="101">101</a>
+<a href="#102" id="102">102</a>
+<a href="#103" id="103">103</a>
+<a href="#104" id="104">104</a>
+<a href="#105" id="105">105</a>
+<a href="#106" id="106">106</a>
+<a href="#107" id="107">107</a>
+<a href="#108" id="108">108</a>
+<a href="#109" id="109">109</a>
+<a href="#110" id="110">110</a>
+<a href="#111" id="111">111</a>
+<a href="#112" id="112">112</a>
+<a href="#113" id="113">113</a>
+<a href="#114" id="114">114</a>
+<a href="#115" id="115">115</a>
+<a href="#116" id="116">116</a>
+<a href="#117" id="117">117</a>
+<a href="#118" id="118">118</a>
+<a href="#119" id="119">119</a>
+<a href="#120" id="120">120</a>
+<a href="#121" id="121">121</a>
+<a href="#122" id="122">122</a>
+<a href="#123" id="123">123</a>
+<a href="#124" id="124">124</a>
+<a href="#125" id="125">125</a>
+<a href="#126" id="126">126</a>
+<a href="#127" id="127">127</a>
+<a href="#128" id="128">128</a>
+<a href="#129" id="129">129</a>
+<a href="#130" id="130">130</a>
+<a href="#131" id="131">131</a>
+<a href="#132" id="132">132</a>
+<a href="#133" id="133">133</a>
+<a href="#134" id="134">134</a>
+<a href="#135" id="135">135</a>
+<a href="#136" id="136">136</a>
+<a href="#137" id="137">137</a>
+<a href="#138" id="138">138</a>
+<a href="#139" id="139">139</a>
+<a href="#140" id="140">140</a>
+<a href="#141" id="141">141</a>
+<a href="#142" id="142">142</a>
+<a href="#143" id="143">143</a>
+<a href="#144" id="144">144</a>
+<a href="#145" id="145">145</a>
+<a href="#146" id="146">146</a>
+<a href="#147" id="147">147</a>
+<a href="#148" id="148">148</a>
+<a href="#149" id="149">149</a>
+<a href="#150" id="150">150</a>
+<a href="#151" id="151">151</a>
+<a href="#152" id="152">152</a>
+<a href="#153" id="153">153</a>
+<a href="#154" id="154">154</a>
+<a href="#155" id="155">155</a>
+<a href="#156" id="156">156</a>
+<a href="#157" id="157">157</a>
+<a href="#158" id="158">158</a>
+<a href="#159" id="159">159</a>
+<a href="#160" id="160">160</a>
+<a href="#161" id="161">161</a>
+<a href="#162" id="162">162</a>
+<a href="#163" id="163">163</a>
+<a href="#164" id="164">164</a>
+<a href="#165" id="165">165</a>
+<a href="#166" id="166">166</a>
+<a href="#167" id="167">167</a>
+<a href="#168" id="168">168</a>
+<a href="#169" id="169">169</a>
+<a href="#170" id="170">170</a>
+<a href="#171" id="171">171</a>
+<a href="#172" id="172">172</a>
+<a href="#173" id="173">173</a>
+<a href="#174" id="174">174</a>
+<a href="#175" id="175">175</a>
+<a href="#176" id="176">176</a>
+<a href="#177" id="177">177</a>
+<a href="#178" id="178">178</a>
+<a href="#179" id="179">179</a>
+<a href="#180" id="180">180</a>
+<a href="#181" id="181">181</a>
+<a href="#182" id="182">182</a>
+<a href="#183" id="183">183</a>
+<a href="#184" id="184">184</a>
+<a href="#185" id="185">185</a>
+<a href="#186" id="186">186</a>
+<a href="#187" id="187">187</a>
+<a href="#188" id="188">188</a>
+<a href="#189" id="189">189</a>
+<a href="#190" id="190">190</a>
+<a href="#191" id="191">191</a>
+<a href="#192" id="192">192</a>
+<a href="#193" id="193">193</a>
+<a href="#194" id="194">194</a>
+<a href="#195" id="195">195</a>
+<a href="#196" id="196">196</a>
+<a href="#197" id="197">197</a>
+<a href="#198" id="198">198</a>
+<a href="#199" id="199">199</a>
+<a href="#200" id="200">200</a>
+<a href="#201" id="201">201</a>
+<a href="#202" id="202">202</a>
+<a href="#203" id="203">203</a>
+<a href="#204" id="204">204</a>
+<a href="#205" id="205">205</a>
+<a href="#206" id="206">206</a>
+<a href="#207" id="207">207</a>
+<a href="#208" id="208">208</a>
+<a href="#209" id="209">209</a>
+<a href="#210" id="210">210</a>
+<a href="#211" id="211">211</a>
+<a href="#212" id="212">212</a>
+<a href="#213" id="213">213</a>
+<a href="#214" id="214">214</a>
+<a href="#215" id="215">215</a>
+<a href="#216" id="216">216</a>
+<a href="#217" id="217">217</a>
+<a href="#218" id="218">218</a>
+<a href="#219" id="219">219</a>
+<a href="#220" id="220">220</a>
+<a href="#221" id="221">221</a>
+<a href="#222" id="222">222</a>
+<a href="#223" id="223">223</a>
+<a href="#224" id="224">224</a>
+<a href="#225" id="225">225</a>
+<a href="#226" id="226">226</a>
+<a href="#227" id="227">227</a>
+<a href="#228" id="228">228</a>
+<a href="#229" id="229">229</a>
+<a href="#230" id="230">230</a>
+<a href="#231" id="231">231</a>
+<a href="#232" id="232">232</a>
+<a href="#233" id="233">233</a>
+<a href="#234" id="234">234</a>
+<a href="#235" id="235">235</a>
+<a href="#236" id="236">236</a>
+<a href="#237" id="237">237</a>
+<a href="#238" id="238">238</a>
+<a href="#239" id="239">239</a>
+<a href="#240" id="240">240</a>
+<a href="#241" id="241">241</a>
+<a href="#242" id="242">242</a>
+<a href="#243" id="243">243</a>
+<a href="#244" id="244">244</a>
+<a href="#245" id="245">245</a>
+<a href="#246" id="246">246</a>
+<a href="#247" id="247">247</a>
+<a href="#248" id="248">248</a>
+<a href="#249" id="249">249</a>
+<a href="#250" id="250">250</a>
+<a href="#251" id="251">251</a>
+<a href="#252" id="252">252</a>
+<a href="#253" id="253">253</a>
+<a href="#254" id="254">254</a>
+<a href="#255" id="255">255</a>
+<a href="#256" id="256">256</a>
+<a href="#257" id="257">257</a>
+<a href="#258" id="258">258</a>
+<a href="#259" id="259">259</a>
+<a href="#260" id="260">260</a>
+<a href="#261" id="261">261</a>
+<a href="#262" id="262">262</a>
+<a href="#263" id="263">263</a>
+<a href="#264" id="264">264</a>
+<a href="#265" id="265">265</a>
+<a href="#266" id="266">266</a>
+<a href="#267" id="267">267</a>
+<a href="#268" id="268">268</a>
+<a href="#269" id="269">269</a>
+<a href="#270" id="270">270</a>
+<a href="#271" id="271">271</a>
+<a href="#272" id="272">272</a>
+<a href="#273" id="273">273</a>
+<a href="#274" id="274">274</a>
+<a href="#275" id="275">275</a>
+<a href="#276" id="276">276</a>
+<a href="#277" id="277">277</a>
+<a href="#278" id="278">278</a>
+<a href="#279" id="279">279</a>
+<a href="#280" id="280">280</a>
+<a href="#281" id="281">281</a>
+<a href="#282" id="282">282</a>
+<a href="#283" id="283">283</a>
+<a href="#284" id="284">284</a>
+<a href="#285" id="285">285</a>
+<a href="#286" id="286">286</a>
+<a href="#287" id="287">287</a>
+<a href="#288" id="288">288</a>
+<a href="#289" id="289">289</a>
+<a href="#290" id="290">290</a>
+<a href="#291" id="291">291</a>
+<a href="#292" id="292">292</a>
+<a href="#293" id="293">293</a>
+<a href="#294" id="294">294</a>
+<a href="#295" id="295">295</a>
+<a href="#296" id="296">296</a>
+<a href="#297" id="297">297</a>
+<a href="#298" id="298">298</a>
+<a href="#299" id="299">299</a>
+<a href="#300" id="300">300</a>
+<a href="#301" id="301">301</a>
+<a href="#302" id="302">302</a>
+<a href="#303" id="303">303</a>
+<a href="#304" id="304">304</a>
+<a href="#305" id="305">305</a>
+<a href="#306" id="306">306</a>
+<a href="#307" id="307">307</a>
+<a href="#308" id="308">308</a>
+<a href="#309" id="309">309</a>
+<a href="#310" id="310">310</a>
+<a href="#311" id="311">311</a>
+<a href="#312" id="312">312</a>
+<a href="#313" id="313">313</a>
+<a href="#314" id="314">314</a>
+<a href="#315" id="315">315</a>
+<a href="#316" id="316">316</a>
+<a href="#317" id="317">317</a>
+<a href="#318" id="318">318</a>
+<a href="#319" id="319">319</a>
+<a href="#320" id="320">320</a>
+<a href="#321" id="321">321</a>
+<a href="#322" id="322">322</a>
+<a href="#323" id="323">323</a>
+<a href="#324" id="324">324</a>
+<a href="#325" id="325">325</a>
+<a href="#326" id="326">326</a>
+<a href="#327" id="327">327</a>
+<a href="#328" id="328">328</a>
+<a href="#329" id="329">329</a>
+<a href="#330" id="330">330</a>
+<a href="#331" id="331">331</a>
+<a href="#332" id="332">332</a>
+<a href="#333" id="333">333</a>
+<a href="#334" id="334">334</a>
+<a href="#335" id="335">335</a>
+<a href="#336" id="336">336</a>
+<a href="#337" id="337">337</a>
+<a href="#338" id="338">338</a>
+<a href="#339" id="339">339</a>
+<a href="#340" id="340">340</a>
+<a href="#341" id="341">341</a>
+<a href="#342" id="342">342</a>
+<a href="#343" id="343">343</a>
+<a href="#344" id="344">344</a>
+<a href="#345" id="345">345</a>
+<a href="#346" id="346">346</a>
+<a href="#347" id="347">347</a>
+<a href="#348" id="348">348</a>
+<a href="#349" id="349">349</a>
+<a href="#350" id="350">350</a>
+<a href="#351" id="351">351</a>
+<a href="#352" id="352">352</a>
+<a href="#353" id="353">353</a>
+<a href="#354" id="354">354</a>
+<a href="#355" id="355">355</a>
+<a href="#356" id="356">356</a>
+<a href="#357" id="357">357</a>
+<a href="#358" id="358">358</a>
+<a href="#359" id="359">359</a>
+<a href="#360" id="360">360</a>
+<a href="#361" id="361">361</a>
+<a href="#362" id="362">362</a>
+<a href="#363" id="363">363</a>
+<a href="#364" id="364">364</a>
+<a href="#365" id="365">365</a>
+<a href="#366" id="366">366</a>
+<a href="#367" id="367">367</a>
+<a href="#368" id="368">368</a>
+<a href="#369" id="369">369</a>
+<a href="#370" id="370">370</a>
+<a href="#371" id="371">371</a>
+<a href="#372" id="372">372</a>
+<a href="#373" id="373">373</a>
+<a href="#374" id="374">374</a>
+<a href="#375" id="375">375</a>
+<a href="#376" id="376">376</a>
+<a href="#377" id="377">377</a>
+<a href="#378" id="378">378</a>
+<a href="#379" id="379">379</a>
+<a href="#380" id="380">380</a>
+<a href="#381" id="381">381</a>
+<a href="#382" id="382">382</a>
+<a href="#383" id="383">383</a>
+<a href="#384" id="384">384</a>
+<a href="#385" id="385">385</a>
+<a href="#386" id="386">386</a>
+<a href="#387" id="387">387</a>
+<a href="#388" id="388">388</a>
+<a href="#389" id="389">389</a>
+<a href="#390" id="390">390</a>
+<a href="#391" id="391">391</a>
+<a href="#392" id="392">392</a>
+<a href="#393" id="393">393</a>
+<a href="#394" id="394">394</a>
+<a href="#395" id="395">395</a>
+<a href="#396" id="396">396</a>
+<a href="#397" id="397">397</a>
+<a href="#398" id="398">398</a>
+<a href="#399" id="399">399</a>
+<a href="#400" id="400">400</a>
+<a href="#401" id="401">401</a>
+<a href="#402" id="402">402</a>
+<a href="#403" id="403">403</a>
+<a href="#404" id="404">404</a>
+<a href="#405" id="405">405</a>
+<a href="#406" id="406">406</a>
+<a href="#407" id="407">407</a>
+<a href="#408" id="408">408</a>
+<a href="#409" id="409">409</a>
+<a href="#410" id="410">410</a>
+<a href="#411" id="411">411</a>
+<a href="#412" id="412">412</a>
+<a href="#413" id="413">413</a>
+<a href="#414" id="414">414</a>
+<a href="#415" id="415">415</a>
+<a href="#416" id="416">416</a>
+<a href="#417" id="417">417</a>
+<a href="#418" id="418">418</a>
+<a href="#419" id="419">419</a>
+<a href="#420" id="420">420</a>
+<a href="#421" id="421">421</a>
+<a href="#422" id="422">422</a>
+<a href="#423" id="423">423</a>
+<a href="#424" id="424">424</a>
+<a href="#425" id="425">425</a>
+<a href="#426" id="426">426</a>
+<a href="#427" id="427">427</a>
+<a href="#428" id="428">428</a>
+<a href="#429" id="429">429</a>
+<a href="#430" id="430">430</a>
+<a href="#431" id="431">431</a>
+<a href="#432" id="432">432</a>
+<a href="#433" id="433">433</a>
+<a href="#434" id="434">434</a>
+<a href="#435" id="435">435</a>
+<a href="#436" id="436">436</a>
+<a href="#437" id="437">437</a>
+<a href="#438" id="438">438</a>
+<a href="#439" id="439">439</a>
+<a href="#440" id="440">440</a>
+<a href="#441" id="441">441</a>
+<a href="#442" id="442">442</a>
+<a href="#443" id="443">443</a>
+<a href="#444" id="444">444</a>
+<a href="#445" id="445">445</a>
+<a href="#446" id="446">446</a>
+<a href="#447" id="447">447</a>
+<a href="#448" id="448">448</a>
+<a href="#449" id="449">449</a>
+<a href="#450" id="450">450</a>
+<a href="#451" id="451">451</a>
+<a href="#452" id="452">452</a>
+<a href="#453" id="453">453</a>
+<a href="#454" id="454">454</a>
+<a href="#455" id="455">455</a>
+<a href="#456" id="456">456</a>
+<a href="#457" id="457">457</a>
+<a href="#458" id="458">458</a>
+<a href="#459" id="459">459</a>
+<a href="#460" id="460">460</a>
+<a href="#461" id="461">461</a>
+<a href="#462" id="462">462</a>
+<a href="#463" id="463">463</a>
+<a href="#464" id="464">464</a>
+<a href="#465" id="465">465</a>
+<a href="#466" id="466">466</a>
+<a href="#467" id="467">467</a>
+<a href="#468" id="468">468</a>
+<a href="#469" id="469">469</a>
+<a href="#470" id="470">470</a>
+<a href="#471" id="471">471</a>
+<a href="#472" id="472">472</a>
+<a href="#473" id="473">473</a>
+<a href="#474" id="474">474</a>
+<a href="#475" id="475">475</a>
+<a href="#476" id="476">476</a>
+<a href="#477" id="477">477</a>
+<a href="#478" id="478">478</a>
+<a href="#479" id="479">479</a>
+<a href="#480" id="480">480</a>
+<a href="#481" id="481">481</a>
+<a href="#482" id="482">482</a>
+<a href="#483" id="483">483</a>
+<a href="#484" id="484">484</a>
+<a href="#485" id="485">485</a>
+<a href="#486" id="486">486</a>
+<a href="#487" id="487">487</a>
+<a href="#488" id="488">488</a>
+<a href="#489" id="489">489</a>
+<a href="#490" id="490">490</a>
+<a href="#491" id="491">491</a>
+<a href="#492" id="492">492</a>
+<a href="#493" id="493">493</a>
+<a href="#494" id="494">494</a>
+<a href="#495" id="495">495</a>
+<a href="#496" id="496">496</a>
+<a href="#497" id="497">497</a>
+<a href="#498" id="498">498</a>
+<a href="#499" id="499">499</a>
+<a href="#500" id="500">500</a>
+<a href="#501" id="501">501</a>
+<a href="#502" id="502">502</a>
+<a href="#503" id="503">503</a>
+<a href="#504" id="504">504</a>
+<a href="#505" id="505">505</a>
+<a href="#506" id="506">506</a>
+<a href="#507" id="507">507</a>
+<a href="#508" id="508">508</a>
+<a href="#509" id="509">509</a>
+<a href="#510" id="510">510</a>
+<a href="#511" id="511">511</a>
+<a href="#512" id="512">512</a>
+<a href="#513" id="513">513</a>
+<a href="#514" id="514">514</a>
+<a href="#515" id="515">515</a>
+<a href="#516" id="516">516</a>
+<a href="#517" id="517">517</a>
+<a href="#518" id="518">518</a>
+<a href="#519" id="519">519</a>
+<a href="#520" id="520">520</a>
+<a href="#521" id="521">521</a>
+<a href="#522" id="522">522</a>
+<a href="#523" id="523">523</a>
+<a href="#524" id="524">524</a>
+<a href="#525" id="525">525</a>
+<a href="#526" id="526">526</a>
+<a href="#527" id="527">527</a>
+<a href="#528" id="528">528</a>
+<a href="#529" id="529">529</a>
+<a href="#530" id="530">530</a>
+<a href="#531" id="531">531</a>
+<a href="#532" id="532">532</a>
+<a href="#533" id="533">533</a>
+<a href="#534" id="534">534</a>
+<a href="#535" id="535">535</a>
+<a href="#536" id="536">536</a>
+<a href="#537" id="537">537</a>
+<a href="#538" id="538">538</a>
+<a href="#539" id="539">539</a>
+<a href="#540" id="540">540</a>
+<a href="#541" id="541">541</a>
+<a href="#542" id="542">542</a>
+<a href="#543" id="543">543</a>
+<a href="#544" id="544">544</a>
+<a href="#545" id="545">545</a>
+<a href="#546" id="546">546</a>
+<a href="#547" id="547">547</a>
+<a href="#548" id="548">548</a>
+<a href="#549" id="549">549</a>
+<a href="#550" id="550">550</a>
+<a href="#551" id="551">551</a>
+<a href="#552" id="552">552</a>
+<a href="#553" id="553">553</a>
+<a href="#554" id="554">554</a>
+<a href="#555" id="555">555</a>
+<a href="#556" id="556">556</a>
+<a href="#557" id="557">557</a>
+<a href="#558" id="558">558</a>
+<a href="#559" id="559">559</a>
+<a href="#560" id="560">560</a>
+<a href="#561" id="561">561</a>
+<a href="#562" id="562">562</a>
+<a href="#563" id="563">563</a>
+<a href="#564" id="564">564</a>
+<a href="#565" id="565">565</a>
+<a href="#566" id="566">566</a>
+<a href="#567" id="567">567</a>
+<a href="#568" id="568">568</a>
+<a href="#569" id="569">569</a>
+<a href="#570" id="570">570</a>
+<a href="#571" id="571">571</a>
+<a href="#572" id="572">572</a>
+<a href="#573" id="573">573</a>
+<a href="#574" id="574">574</a>
+<a href="#575" id="575">575</a>
+<a href="#576" id="576">576</a>
+<a href="#577" id="577">577</a>
+<a href="#578" id="578">578</a>
+<a href="#579" id="579">579</a>
+<a href="#580" id="580">580</a>
+<a href="#581" id="581">581</a>
+<a href="#582" id="582">582</a>
+<a href="#583" id="583">583</a>
+<a href="#584" id="584">584</a>
+<a href="#585" id="585">585</a>
+<a href="#586" id="586">586</a>
+<a href="#587" id="587">587</a>
+<a href="#588" id="588">588</a>
+<a href="#589" id="589">589</a>
+<a href="#590" id="590">590</a>
+<a href="#591" id="591">591</a>
+<a href="#592" id="592">592</a>
+<a href="#593" id="593">593</a>
+<a href="#594" id="594">594</a>
+<a href="#595" id="595">595</a>
+<a href="#596" id="596">596</a>
+<a href="#597" id="597">597</a>
+<a href="#598" id="598">598</a>
+<a href="#599" id="599">599</a>
+<a href="#600" id="600">600</a>
+<a href="#601" id="601">601</a>
+<a href="#602" id="602">602</a>
+<a href="#603" id="603">603</a>
+<a href="#604" id="604">604</a>
+<a href="#605" id="605">605</a>
+<a href="#606" id="606">606</a>
+<a href="#607" id="607">607</a>
+<a href="#608" id="608">608</a>
+<a href="#609" id="609">609</a>
+<a href="#610" id="610">610</a>
+<a href="#611" id="611">611</a>
+<a href="#612" id="612">612</a>
+<a href="#613" id="613">613</a>
+<a href="#614" id="614">614</a>
+<a href="#615" id="615">615</a>
+<a href="#616" id="616">616</a>
+<a href="#617" id="617">617</a>
+<a href="#618" id="618">618</a>
+<a href="#619" id="619">619</a>
+<a href="#620" id="620">620</a>
+<a href="#621" id="621">621</a>
+<a href="#622" id="622">622</a>
+<a href="#623" id="623">623</a>
+<a href="#624" id="624">624</a>
+<a href="#625" id="625">625</a>
+<a href="#626" id="626">626</a>
+<a href="#627" id="627">627</a>
+<a href="#628" id="628">628</a>
+<a href="#629" id="629">629</a>
+<a href="#630" id="630">630</a>
+<a href="#631" id="631">631</a>
+<a href="#632" id="632">632</a>
+<a href="#633" id="633">633</a>
+<a href="#634" id="634">634</a>
+<a href="#635" id="635">635</a>
+<a href="#636" id="636">636</a>
+<a href="#637" id="637">637</a>
+<a href="#638" id="638">638</a>
+<a href="#639" id="639">639</a>
+<a href="#640" id="640">640</a>
+<a href="#641" id="641">641</a>
+<a href="#642" id="642">642</a>
+<a href="#643" id="643">643</a>
+<a href="#644" id="644">644</a>
+<a href="#645" id="645">645</a>
+<a href="#646" id="646">646</a>
+<a href="#647" id="647">647</a>
+<a href="#648" id="648">648</a>
+<a href="#649" id="649">649</a>
+<a href="#650" id="650">650</a>
+<a href="#651" id="651">651</a>
+<a href="#652" id="652">652</a>
+<a href="#653" id="653">653</a>
+<a href="#654" id="654">654</a>
+<a href="#655" id="655">655</a>
+<a href="#656" id="656">656</a>
+<a href="#657" id="657">657</a>
+<a href="#658" id="658">658</a>
+<a href="#659" id="659">659</a>
+<a href="#660" id="660">660</a>
+<a href="#661" id="661">661</a>
+<a href="#662" id="662">662</a>
+<a href="#663" id="663">663</a>
+<a href="#664" id="664">664</a>
+<a href="#665" id="665">665</a>
+<a href="#666" id="666">666</a>
+<a href="#667" id="667">667</a>
+<a href="#668" id="668">668</a>
+<a href="#669" id="669">669</a>
+<a href="#670" id="670">670</a>
+<a href="#671" id="671">671</a>
+<a href="#672" id="672">672</a>
+<a href="#673" id="673">673</a>
+<a href="#674" id="674">674</a>
+<a href="#675" id="675">675</a>
+<a href="#676" id="676">676</a>
+<a href="#677" id="677">677</a>
+<a href="#678" id="678">678</a>
+<a href="#679" id="679">679</a>
+<a href="#680" id="680">680</a>
+<a href="#681" id="681">681</a>
+<a href="#682" id="682">682</a>
+<a href="#683" id="683">683</a>
+<a href="#684" id="684">684</a>
+<a href="#685" id="685">685</a>
+<a href="#686" id="686">686</a>
+<a href="#687" id="687">687</a>
+<a href="#688" id="688">688</a>
+<a href="#689" id="689">689</a>
+<a href="#690" id="690">690</a>
+<a href="#691" id="691">691</a>
+<a href="#692" id="692">692</a>
+<a href="#693" id="693">693</a>
+<a href="#694" id="694">694</a>
+<a href="#695" id="695">695</a>
+<a href="#696" id="696">696</a>
+<a href="#697" id="697">697</a>
+<a href="#698" id="698">698</a>
+<a href="#699" id="699">699</a>
+<a href="#700" id="700">700</a>
+<a href="#701" id="701">701</a>
+<a href="#702" id="702">702</a>
+<a href="#703" id="703">703</a>
+<a href="#704" id="704">704</a>
+<a href="#705" id="705">705</a>
+<a href="#706" id="706">706</a>
+<a href="#707" id="707">707</a>
+<a href="#708" id="708">708</a>
+<a href="#709" id="709">709</a>
+<a href="#710" id="710">710</a>
+<a href="#711" id="711">711</a>
+<a href="#712" id="712">712</a>
+<a href="#713" id="713">713</a>
+<a href="#714" id="714">714</a>
+<a href="#715" id="715">715</a>
+<a href="#716" id="716">716</a>
+<a href="#717" id="717">717</a>
+<a href="#718" id="718">718</a>
+<a href="#719" id="719">719</a>
+<a href="#720" id="720">720</a>
+<a href="#721" id="721">721</a>
+<a href="#722" id="722">722</a>
+<a href="#723" id="723">723</a>
+<a href="#724" id="724">724</a>
+<a href="#725" id="725">725</a>
+<a href="#726" id="726">726</a>
+<a href="#727" id="727">727</a>
+<a href="#728" id="728">728</a>
+<a href="#729" id="729">729</a>
+<a href="#730" id="730">730</a>
+<a href="#731" id="731">731</a>
+<a href="#732" id="732">732</a>
+<a href="#733" id="733">733</a>
+<a href="#734" id="734">734</a>
+<a href="#735" id="735">735</a>
+<a href="#736" id="736">736</a>
+<a href="#737" id="737">737</a>
+<a href="#738" id="738">738</a>
+<a href="#739" id="739">739</a>
+<a href="#740" id="740">740</a>
+<a href="#741" id="741">741</a>
+<a href="#742" id="742">742</a>
+<a href="#743" id="743">743</a>
+<a href="#744" id="744">744</a>
+<a href="#745" id="745">745</a>
+<a href="#746" id="746">746</a>
+<a href="#747" id="747">747</a>
+<a href="#748" id="748">748</a>
+<a href="#749" id="749">749</a>
+<a href="#750" id="750">750</a>
+<a href="#751" id="751">751</a>
+<a href="#752" id="752">752</a>
+<a href="#753" id="753">753</a>
+<a href="#754" id="754">754</a>
+<a href="#755" id="755">755</a>
+<a href="#756" id="756">756</a>
+<a href="#757" id="757">757</a>
+<a href="#758" id="758">758</a>
+<a href="#759" id="759">759</a>
+<a href="#760" id="760">760</a>
+<a href="#761" id="761">761</a>
+<a href="#762" id="762">762</a>
+<a href="#763" id="763">763</a>
+<a href="#764" id="764">764</a>
+<a href="#765" id="765">765</a>
+<a href="#766" id="766">766</a>
+<a href="#767" id="767">767</a>
+<a href="#768" id="768">768</a>
+<a href="#769" id="769">769</a>
+<a href="#770" id="770">770</a>
+<a href="#771" id="771">771</a>
+<a href="#772" id="772">772</a>
+<a href="#773" id="773">773</a>
+<a href="#774" id="774">774</a>
+<a href="#775" id="775">775</a>
+<a href="#776" id="776">776</a>
+<a href="#777" id="777">777</a>
+</pre></div><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
+// "License"); 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
+// "AS IS" 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>std::collections::{HashMap, HashSet};
+
+<span class="kw">use </span>bytes::Bytes;
+<span class="kw">use </span>serde::{Deserialize, Serialize};
+
+<span class="kw">use </span><span class="kw">crate</span>::io::{FileRead,
InputFile};
+<span class="kw">use </span><span
class="kw">crate</span>::puffin::compression::CompressionCodec;
+<span class="kw">use crate</span>::{Error, ErrorKind, <span
class="prelude-ty">Result</span>};
+
+<span class="doccomment">/// Human-readable identification of the application
writing the file, along with its version.
+/// Example: "Trino version 381"
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">const </span>CREATED_BY_PROPERTY: <span class="kw-2">&</span>str
= <span class="string">"created-by"</span>;
+
+<span class="doccomment">/// Metadata about a blob.
+/// For more information, see:
https://iceberg.apache.org/puffin-spec/#blobmetadata
+</span><span class="attr">#[derive(Debug, PartialEq, Eq, Serialize,
Deserialize, Clone)]
+#[serde(rename_all = <span class="string">"kebab-case"</span>)]
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">struct </span>BlobMetadata {
+ <span class="doccomment">/// See blob types:
https://iceberg.apache.org/puffin-spec/#blob-types
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) r#type:
String,
+ <span class="doccomment">/// List of field IDs the blob was computed for;
the order of items is used to compute sketches stored in the blob.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) fields:
Vec<i32>,
+ <span class="doccomment">/// ID of the Iceberg table's snapshot the blob
was computed from
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>)
snapshot_id: i64,
+ <span class="doccomment">/// Sequence number of the Iceberg table's
snapshot the blob was computed from
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>)
sequence_number: i64,
+ <span class="doccomment">/// The offset in the file where the blob
contents start
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) offset:
u64,
+ <span class="doccomment">/// The length of the blob stored in the file
(after compression, if compressed)
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) length:
u64,
+ <span class="doccomment">/// The compression codec used to compress the
data
+ </span><span class="attr">#[serde(skip_serializing_if = <span
class="string">"CompressionCodec::is_none"</span>)]
+ #[serde(default)]
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>)
compression_codec: CompressionCodec,
+ <span class="doccomment">/// Arbitrary meta-information about the blob
+ </span><span class="attr">#[serde(skip_serializing_if = <span
class="string">"HashMap::is_empty"</span>)]
+ #[serde(default)]
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>)
properties: HashMap<String, String>,
+}
+
+<span class="attr">#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">enum </span>Flag {
+ FooterPayloadCompressed = <span class="number">0</span>,
+}
+
+<span class="kw">impl </span>Flag {
+ <span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">fn </span>byte_idx(<span class="self">self</span>) -> u8 {
+ (<span class="self">self </span><span class="kw">as </span>u8) / <span
class="number">8
+ </span>}
+
+ <span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">fn </span>bit_idx(<span class="self">self</span>) -> u8 {
+ (<span class="self">self </span><span class="kw">as </span>u8) % <span
class="number">8
+ </span>}
+
+ <span class="kw">fn </span>matches(<span class="self">self</span>,
byte_idx: u8, bit_idx: u8) -> bool {
+ <span class="self">self</span>.byte_idx() == byte_idx && <span
class="self">self</span>.bit_idx() == bit_idx
+ }
+
+ <span class="kw">fn </span>from(byte_idx: u8, bit_idx: u8) -> <span
class="prelude-ty">Result</span><Flag> {
+ <span class="kw">if
</span>Flag::FooterPayloadCompressed.matches(byte_idx, bit_idx) {
+ <span class="prelude-val">Ok</span>(Flag::FooterPayloadCompressed)
+ } <span class="kw">else </span>{
+ <span class="prelude-val">Err</span>(Error::new(
+ ErrorKind::DataInvalid,
+ <span class="macro">format!</span>(
+ <span class="string">"Unknown flag byte {} and bit {}
combination"</span>,
+ byte_idx, bit_idx
+ ),
+ ))
+ }
+ }
+}
+
+<span class="doccomment">/// Metadata about a puffin file.
+/// For more information, see:
https://iceberg.apache.org/puffin-spec/#filemetadata
+</span><span class="attr">#[derive(Debug, PartialEq, Eq, Serialize,
Deserialize, Clone)]
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">struct </span>FileMetadata {
+ <span class="doccomment">/// Metadata about blobs in file
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) blobs:
Vec<BlobMetadata>,
+ <span class="doccomment">/// Arbitrary meta-information, like writer
identification/version.
+ </span><span class="attr">#[serde(skip_serializing_if = <span
class="string">"HashMap::is_empty"</span>)]
+ #[serde(default)]
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>)
properties: HashMap<String, String>,
+}
+
+<span class="kw">impl </span>FileMetadata {
+ <span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">const </span>MAGIC_LENGTH: u8 = <span class="number">4</span>;
+ <span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">const </span>MAGIC: [u8; FileMetadata::MAGIC_LENGTH <span
class="kw">as </span>usize] = [<span class="number">0x50</span>, <span
class="number">0x46</span>, <span class="number">0x41</span>, <span
class="number">0x31</span>];
+
+ <span class="comment">// We use the term FOOTER_STRUCT to refer to the
fixed-length portion of the Footer, as illustrated below.
+ //
+ // Footer
+ // |
+ // -------------------------------------------------
+ // | |
+ // Magic FooterPayload FooterPayloadLength Flags Magic
+ // | |
+ // -----------------------------
+ // |
+ // FOOTER_STRUCT
+
+ </span><span class="kw">const </span>FOOTER_STRUCT_PAYLOAD_LENGTH_OFFSET:
u8 = <span class="number">0</span>;
+ <span class="kw">const </span>FOOTER_STRUCT_PAYLOAD_LENGTH_LENGTH: u8 =
<span class="number">4</span>;
+ <span class="kw">const </span>FOOTER_STRUCT_FLAGS_OFFSET: u8 =
FileMetadata::FOOTER_STRUCT_PAYLOAD_LENGTH_OFFSET
+ + FileMetadata::FOOTER_STRUCT_PAYLOAD_LENGTH_LENGTH;
+ <span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">const </span>FOOTER_STRUCT_FLAGS_LENGTH: u8 = <span
class="number">4</span>;
+ <span class="kw">const </span>FOOTER_STRUCT_MAGIC_OFFSET: u8 =
+ FileMetadata::FOOTER_STRUCT_FLAGS_OFFSET +
FileMetadata::FOOTER_STRUCT_FLAGS_LENGTH;
+ <span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">const </span>FOOTER_STRUCT_LENGTH: u8 =
+ FileMetadata::FOOTER_STRUCT_MAGIC_OFFSET + FileMetadata::MAGIC_LENGTH;
+
+ <span class="kw">fn </span>check_magic(bytes: <span
class="kw-2">&</span>[u8]) -> <span
class="prelude-ty">Result</span><()> {
+ <span class="kw">if </span>bytes == FileMetadata::MAGIC {
+ <span class="prelude-val">Ok</span>(())
+ } <span class="kw">else </span>{
+ <span class="prelude-val">Err</span>(Error::new(
+ ErrorKind::DataInvalid,
+ <span class="macro">format!</span>(
+ <span class="string">"Bad magic value: {:?} should be
{:?}"</span>,
+ bytes,
+ FileMetadata::MAGIC
+ ),
+ ))
+ }
+ }
+
+ <span class="kw">async fn </span>read_footer_payload_length(
+ file_read: <span class="kw-2">&</span><span class="kw">dyn
</span>FileRead,
+ input_file_length: u64,
+ ) -> <span class="prelude-ty">Result</span><u32> {
+ <span class="kw">let </span>start = input_file_length -
FileMetadata::FOOTER_STRUCT_LENGTH <span class="kw">as </span>u64;
+ <span class="kw">let </span>end = start +
FileMetadata::FOOTER_STRUCT_PAYLOAD_LENGTH_LENGTH <span class="kw">as
</span>u64;
+ <span class="kw">let </span>footer_payload_length_bytes =
file_read.read(start..end).<span class="kw">await</span><span
class="question-mark">?</span>;
+ <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span
class="number">0</span>; <span class="number">4</span>];
+ buf.copy_from_slice(<span
class="kw-2">&</span>footer_payload_length_bytes);
+ <span class="kw">let </span>footer_payload_length =
u32::from_le_bytes(buf);
+ <span class="prelude-val">Ok</span>(footer_payload_length)
+ }
+
+ <span class="kw">async fn </span>read_footer_bytes(
+ file_read: <span class="kw-2">&</span><span class="kw">dyn
</span>FileRead,
+ input_file_length: u64,
+ footer_payload_length: u32,
+ ) -> <span class="prelude-ty">Result</span><Bytes> {
+ <span class="kw">let </span>footer_length = footer_payload_length
<span class="kw">as </span>u64
+ + FileMetadata::FOOTER_STRUCT_LENGTH <span class="kw">as </span>u64
+ + FileMetadata::MAGIC_LENGTH <span class="kw">as </span>u64;
+ <span class="kw">let </span>start = input_file_length - footer_length;
+ <span class="kw">let </span>end = input_file_length;
+ file_read.read(start..end).<span class="kw">await
+ </span>}
+
+ <span class="kw">fn </span>decode_flags(footer_bytes: <span
class="kw-2">&</span>[u8]) -> <span
class="prelude-ty">Result</span><HashSet<Flag>> {
+ <span class="kw">let </span><span class="kw-2">mut </span>flags =
HashSet::new();
+
+ <span class="kw">for </span>byte_idx <span class="kw">in </span><span
class="number">0</span>..FileMetadata::FOOTER_STRUCT_FLAGS_LENGTH {
+ <span class="kw">let </span>byte_offset = footer_bytes.len()
+ - FileMetadata::MAGIC_LENGTH <span class="kw">as </span>usize
+ - FileMetadata::FOOTER_STRUCT_FLAGS_LENGTH <span class="kw">as
</span>usize
+ + byte_idx <span class="kw">as </span>usize;
+
+ <span class="kw">let </span>flag_byte = <span
class="kw-2">*</span>footer_bytes.get(byte_offset).ok_or_else(|| {
+ Error::new(ErrorKind::DataInvalid, <span class="string">"Index
range is out of bounds."</span>)
+ })<span class="question-mark">?</span>;
+
+ <span class="kw">for </span>bit_idx <span class="kw">in
</span><span class="number">0</span>..<span class="number">8 </span>{
+ <span class="kw">if </span>((flag_byte >> bit_idx) &
<span class="number">1</span>) != <span class="number">0 </span>{
+ <span class="kw">let </span>flag = Flag::from(byte_idx,
bit_idx)<span class="question-mark">?</span>;
+ flags.insert(flag);
+ }
+ }
+ }
+
+ <span class="prelude-val">Ok</span>(flags)
+ }
+
+ <span class="kw">fn </span>extract_footer_payload_as_str(
+ footer_bytes: <span class="kw-2">&</span>[u8],
+ footer_payload_length: u32,
+ ) -> <span class="prelude-ty">Result</span><String> {
+ <span class="kw">let </span>flags =
FileMetadata::decode_flags(footer_bytes)<span class="question-mark">?</span>;
+ <span class="kw">let </span>footer_compression_codec = <span
class="kw">if </span>flags.contains(<span
class="kw-2">&</span>Flag::FooterPayloadCompressed) {
+ CompressionCodec::Lz4
+ } <span class="kw">else </span>{
+ CompressionCodec::None
+ };
+
+ <span class="kw">let </span>start_offset = FileMetadata::MAGIC_LENGTH
<span class="kw">as </span>usize;
+ <span class="kw">let </span>end_offset =
+ FileMetadata::MAGIC_LENGTH <span class="kw">as </span>usize +
usize::try_from(footer_payload_length)<span class="question-mark">?</span>;
+ <span class="kw">let </span>footer_payload_bytes = footer_bytes
+ .get(start_offset..end_offset)
+ .ok_or_else(|| Error::new(ErrorKind::DataInvalid, <span
class="string">"Index range is out of bounds."</span>))<span
class="question-mark">?</span>;
+ <span class="kw">let </span>decompressed_footer_payload_bytes =
+
footer_compression_codec.decompress(footer_payload_bytes.into())<span
class="question-mark">?</span>;
+
+ String::from_utf8(decompressed_footer_payload_bytes).map_err(|src| {
+ Error::new(ErrorKind::DataInvalid, <span class="string">"Footer is
not a valid UTF-8 string"</span>)
+ .with_source(src)
+ })
+ }
+
+ <span class="kw">fn </span>from_json_str(string: <span
class="kw-2">&</span>str) -> <span
class="prelude-ty">Result</span><FileMetadata> {
+ serde_json::from_str::<FileMetadata>(string).map_err(|src| {
+ Error::new(ErrorKind::DataInvalid, <span class="string">"Given
string is not valid JSON"</span>).with_source(src)
+ })
+ }
+
+ <span class="doccomment">/// Returns the file metadata about a Puffin file
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span
class="kw">async fn </span>read(input_file: <span
class="kw-2">&</span>InputFile) -> <span
class="prelude-ty">Result</span><FileMetadata> {
+ <span class="kw">let </span>file_read = input_file.reader().<span
class="kw">await</span><span class="question-mark">?</span>;
+
+ <span class="kw">let </span>first_four_bytes = file_read.read(<span
class="number">0</span>..FileMetadata::MAGIC_LENGTH.into()).<span
class="kw">await</span><span class="question-mark">?</span>;
+ FileMetadata::check_magic(<span
class="kw-2">&</span>first_four_bytes)<span class="question-mark">?</span>;
+
+ <span class="kw">let </span>input_file_length =
input_file.metadata().<span class="kw">await</span><span
class="question-mark">?</span>.size;
+ <span class="kw">let </span>footer_payload_length =
+ FileMetadata::read_footer_payload_length(<span
class="kw-2">&</span>file_read, input_file_length).<span
class="kw">await</span><span class="question-mark">?</span>;
+ <span class="kw">let </span>footer_bytes =
+ FileMetadata::read_footer_bytes(<span
class="kw-2">&</span>file_read, input_file_length, footer_payload_length)
+ .<span class="kw">await</span><span
class="question-mark">?</span>;
+
+ <span class="kw">let </span>magic_length = FileMetadata::MAGIC_LENGTH
<span class="kw">as </span>usize;
+ <span class="comment">// check first four bytes of footer
+ </span>FileMetadata::check_magic(<span
class="kw-2">&</span>footer_bytes[..magic_length])<span
class="question-mark">?</span>;
+ <span class="comment">// check last four bytes of footer
+ </span>FileMetadata::check_magic(<span
class="kw-2">&</span>footer_bytes[footer_bytes.len() -
magic_length..])<span class="question-mark">?</span>;
+
+ <span class="kw">let </span>footer_payload_str =
+ FileMetadata::extract_footer_payload_as_str(<span
class="kw-2">&</span>footer_bytes, footer_payload_length)<span
class="question-mark">?</span>;
+ FileMetadata::from_json_str(<span
class="kw-2">&</span>footer_payload_str)
+ }
+}
+
+<span class="attr">#[cfg(test)]
+</span><span class="kw">mod </span>tests {
+ <span class="kw">use </span>std::collections::HashMap;
+
+ <span class="kw">use </span>bytes::Bytes;
+ <span class="kw">use </span>tempfile::TempDir;
+
+ <span class="kw">use </span><span
class="kw">crate</span>::io::{FileIOBuilder, InputFile};
+ <span class="kw">use </span><span
class="kw">crate</span>::puffin::metadata::{BlobMetadata, CompressionCodec,
FileMetadata};
+ <span class="kw">use </span><span
class="kw">crate</span>::puffin::test_utils::{
+ empty_footer_payload, empty_footer_payload_bytes,
empty_footer_payload_bytes_length_bytes,
+ java_empty_uncompressed_input_file,
java_uncompressed_metric_input_file,
+ java_zstd_compressed_metric_input_file,
uncompressed_metric_file_metadata,
+ zstd_compressed_metric_file_metadata,
+ };
+
+ <span class="kw">const </span>INVALID_MAGIC_VALUE: [u8; <span
class="number">4</span>] = [<span class="number">80</span>, <span
class="number">70</span>, <span class="number">65</span>, <span
class="number">0</span>];
+
+ <span class="kw">async fn </span>input_file_with_bytes(temp_dir: <span
class="kw-2">&</span>TempDir, slice: <span class="kw-2">&</span>[u8])
-> InputFile {
+ <span class="kw">let </span>file_io =
FileIOBuilder::new_fs_io().build().unwrap();
+
+ <span class="kw">let </span>path_buf = temp_dir.path().join(<span
class="string">"abc.puffin"</span>);
+ <span class="kw">let </span>temp_path = path_buf.to_str().unwrap();
+ <span class="kw">let </span>output_file =
file_io.new_output(temp_path).unwrap();
+
+ output_file
+ .write(Bytes::copy_from_slice(slice))
+ .<span class="kw">await
+ </span>.unwrap();
+
+ output_file.to_input_file()
+ }
+
+ <span class="kw">async fn </span>input_file_with_payload(temp_dir: <span
class="kw-2">&</span>TempDir, payload_str: <span
class="kw-2">&</span>str) -> InputFile {
+ <span class="kw">let </span>payload_bytes = payload_str.as_bytes();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(payload_bytes);
+ bytes.extend(u32::to_le_bytes(payload_bytes.len() <span class="kw">as
</span>u32));
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC);
+
+ input_file_with_bytes(temp_dir, <span
class="kw-2">&</span>bytes).<span class="kw">await
+ </span>}
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_file_starting_with_invalid_magic_returns_error() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(INVALID_MAGIC_VALUE.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(empty_footer_payload_bytes_length_bytes());
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC);
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span class="kw-2">&</span>input_file)
+ .<span class="kw">await
+ </span>.unwrap_err()
+ .to_string(),
+ <span class="string">"DataInvalid => Bad magic value: [80, 70,
65, 0] should be [80, 70, 65, 49]"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_file_with_invalid_magic_at_start_of_footer_returns_error() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(INVALID_MAGIC_VALUE.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(empty_footer_payload_bytes_length_bytes());
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC);
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span class="kw-2">&</span>input_file)
+ .<span class="kw">await
+ </span>.unwrap_err()
+ .to_string(),
+ <span class="string">"DataInvalid => Bad magic value: [80, 70,
65, 0] should be [80, 70, 65, 49]"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_file_ending_with_invalid_magic_returns_error() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(empty_footer_payload_bytes_length_bytes());
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(INVALID_MAGIC_VALUE);
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span class="kw-2">&</span>input_file)
+ .<span class="kw">await
+ </span>.unwrap_err()
+ .to_string(),
+ <span class="string">"DataInvalid => Bad magic value: [80, 70,
65, 0] should be [80, 70, 65, 49]"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_encoded_payload_length_larger_than_actual_payload_length_returns_error()
{
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(u32::to_le_bytes(
+ empty_footer_payload_bytes().len() <span class="kw">as </span>u32
+ <span class="number">1</span>,
+ ));
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span class="kw-2">&</span>input_file)
+ .<span class="kw">await
+ </span>.unwrap_err()
+ .to_string(),
+ <span class="string">"DataInvalid => Bad magic value: [49, 80,
70, 65] should be [80, 70, 65, 49]"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_encoded_payload_length_smaller_than_actual_payload_length_returns_error()
{
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(u32::to_le_bytes(
+ empty_footer_payload_bytes().len() <span class="kw">as </span>u32
- <span class="number">1</span>,
+ ));
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span class="kw-2">&</span>input_file)
+ .<span class="kw">await
+ </span>.unwrap_err()
+ .to_string(),
+ <span class="string">"DataInvalid => Bad magic value: [70, 65,
49, 123] should be [80, 70, 65, 49]"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_lz4_compressed_footer_returns_error() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(empty_footer_payload_bytes_length_bytes());
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0b00000001</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span class="kw-2">&</span>input_file)
+ .<span class="kw">await
+ </span>.unwrap_err()
+ .to_string(),
+ <span class="string">"FeatureUnsupported => LZ4 decompression
is not supported currently"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_unknown_byte_bit_combination_returns_error() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(empty_footer_payload_bytes_length_bytes());
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0b00000010</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span class="kw-2">&</span>input_file)
+ .<span class="kw">await
+ </span>.unwrap_err()
+ .to_string(),
+ <span class="string">"DataInvalid => Unknown flag byte 0 and
bit 1 combination"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_non_utf8_string_payload_returns_error() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>payload_bytes: [u8; <span
class="number">4</span>] = [<span class="number">0</span>, <span
class="number">159</span>, <span class="number">146</span>, <span
class="number">150</span>];
+ <span class="kw">let </span>payload_bytes_length_bytes: [u8; <span
class="number">4</span>] = u32::to_le_bytes(payload_bytes.len() <span
class="kw">as </span>u32);
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(payload_bytes);
+ bytes.extend(payload_bytes_length_bytes);
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span
class="kw">await</span>.unwrap_err().to_string(),
+ <span class="string">"DataInvalid => Footer is not a valid
UTF-8 string, source: invalid utf-8 sequence of 1 bytes from index 1"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_minimal_valid_file_returns_file_metadata() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span><span class="kw-2">mut </span>bytes =
<span class="macro">vec!</span>[];
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(FileMetadata::MAGIC.to_vec());
+ bytes.extend(empty_footer_payload_bytes());
+ bytes.extend(empty_footer_payload_bytes_length_bytes());
+ bytes.extend(<span class="macro">vec!</span>[<span
class="number">0</span>, <span class="number">0</span>, <span
class="number">0</span>, <span class="number">0</span>]);
+ bytes.extend(FileMetadata::MAGIC);
+
+ <span class="kw">let </span>input_file = input_file_with_bytes(<span
class="kw-2">&</span>temp_dir, <span class="kw-2">&</span>bytes).<span
class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap(),
+ FileMetadata {
+ blobs: <span class="macro">vec!</span>[],
+ properties: HashMap::new(),
+ }
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_returns_file_metadata_property() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>input_file = input_file_with_payload(
+ <span class="kw-2">&</span>temp_dir,
+ <span class="string">r#"{
+ "blobs" : [ ],
+ "properties" : {
+ "a property" : "a property value"
+ }
+ }"#</span>,
+ )
+ .<span class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap(),
+ FileMetadata {
+ blobs: <span class="macro">vec!</span>[],
+ properties: {
+ <span class="kw">let </span><span class="kw-2">mut
</span>map = HashMap::new();
+ map.insert(<span class="string">"a
property"</span>.to_string(), <span class="string">"a property
value"</span>.to_string());
+ map
+ },
+ }
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_returns_file_metadata_properties() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>input_file = input_file_with_payload(
+ <span class="kw-2">&</span>temp_dir,
+ <span class="string">r#"{
+ "blobs" : [ ],
+ "properties" : {
+ "a property" : "a property value",
+ "another one": "also with value"
+ }
+ }"#</span>,
+ )
+ .<span class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap(),
+ FileMetadata {
+ blobs: <span class="macro">vec!</span>[],
+ properties: {
+ <span class="kw">let </span><span class="kw-2">mut
</span>map = HashMap::new();
+ map.insert(<span class="string">"a
property"</span>.to_string(), <span class="string">"a property
value"</span>.to_string());
+ map.insert(<span class="string">"another
one"</span>.to_string(), <span class="string">"also with
value"</span>.to_string());
+ map
+ },
+ }
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_returns_error_if_blobs_field_is_missing() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>input_file = input_file_with_payload(
+ <span class="kw-2">&</span>temp_dir,
+ <span class="string">r#"{
+ "properties" : {}
+ }"#</span>,
+ )
+ .<span class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span
class="kw">await</span>.unwrap_err().to_string(),
+ <span class="macro">format!</span>(
+ <span class="string">"DataInvalid => Given string is not
valid JSON, source: missing field `blobs` at line 3 column 13"
+ </span>),
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_returns_error_if_blobs_field_is_bad() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>input_file = input_file_with_payload(
+ <span class="kw-2">&</span>temp_dir,
+ <span class="string">r#"{
+ "blobs" : {}
+ }"#</span>,
+ )
+ .<span class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span
class="kw">await</span>.unwrap_err().to_string(),
+ <span class="macro">format!</span>(<span
class="string">"DataInvalid => Given string is not valid JSON, source:
invalid type: map, expected a sequence at line 2 column 26"</span>),
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn </span>test_returns_blobs_metadatas() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>input_file = input_file_with_payload(
+ <span class="kw-2">&</span>temp_dir,
+ <span class="string">r#"{
+ "blobs" : [
+ {
+ "type" : "type-a",
+ "fields" : [ 1 ],
+ "snapshot-id" : 14,
+ "sequence-number" : 3,
+ "offset" : 4,
+ "length" : 16
+ },
+ {
+ "type" : "type-bbb",
+ "fields" : [ 2, 3, 4 ],
+ "snapshot-id" : 77,
+ "sequence-number" : 4,
+ "offset" : 21474836470000,
+ "length" : 79834
+ }
+ ]
+ }"#</span>,
+ )
+ .<span class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap(),
+ FileMetadata {
+ blobs: <span class="macro">vec!</span>[
+ BlobMetadata {
+ r#type: <span
class="string">"type-a"</span>.to_string(),
+ fields: <span class="macro">vec!</span>[<span
class="number">1</span>],
+ snapshot_id: <span class="number">14</span>,
+ sequence_number: <span class="number">3</span>,
+ offset: <span class="number">4</span>,
+ length: <span class="number">16</span>,
+ compression_codec: CompressionCodec::None,
+ properties: HashMap::new(),
+ },
+ BlobMetadata {
+ r#type: <span
class="string">"type-bbb"</span>.to_string(),
+ fields: <span class="macro">vec!</span>[<span
class="number">2</span>, <span class="number">3</span>, <span
class="number">4</span>],
+ snapshot_id: <span class="number">77</span>,
+ sequence_number: <span class="number">4</span>,
+ offset: <span class="number">21474836470000</span>,
+ length: <span class="number">79834</span>,
+ compression_codec: CompressionCodec::None,
+ properties: HashMap::new(),
+ },
+ ],
+ properties: HashMap::new(),
+ }
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_returns_properties_in_blob_metadata() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>input_file = input_file_with_payload(
+ <span class="kw-2">&</span>temp_dir,
+ <span class="string">r#"{
+ "blobs" : [
+ {
+ "type" : "type-a",
+ "fields" : [ 1 ],
+ "snapshot-id" : 14,
+ "sequence-number" : 3,
+ "offset" : 4,
+ "length" : 16,
+ "properties" : {
+ "some key" : "some value"
+ }
+ }
+ ]
+ }"#</span>,
+ )
+ .<span class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap(),
+ FileMetadata {
+ blobs: <span class="macro">vec!</span>[BlobMetadata {
+ r#type: <span class="string">"type-a"</span>.to_string(),
+ fields: <span class="macro">vec!</span>[<span
class="number">1</span>],
+ snapshot_id: <span class="number">14</span>,
+ sequence_number: <span class="number">3</span>,
+ offset: <span class="number">4</span>,
+ length: <span class="number">16</span>,
+ compression_codec: CompressionCodec::None,
+ properties: {
+ <span class="kw">let </span><span class="kw-2">mut
</span>map = HashMap::new();
+ map.insert(<span class="string">"some
key"</span>.to_string(), <span class="string">"some value"</span>.to_string());
+ map
+ },
+ }],
+ properties: HashMap::new(),
+ }
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_returns_error_if_blobs_fields_value_is_outside_i32_range() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>out_of_i32_range_number: i64 = i32::MAX
<span class="kw">as </span>i64 + <span class="number">1</span>;
+
+ <span class="kw">let </span>input_file = input_file_with_payload(
+ <span class="kw-2">&</span>temp_dir,
+ <span class="kw-2">&</span><span class="macro">format!</span>(
+ <span class="string">r#"{{
+ "blobs" : [
+ {{
+ "type" : "type-a",
+ "fields" : [ {} ],
+ "snapshot-id" : 14,
+ "sequence-number" : 3,
+ "offset" : 4,
+ "length" : 16
+ }}
+ ]
+ }}"#</span>,
+ out_of_i32_range_number
+ ),
+ )
+ .<span class="kw">await</span>;
+
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span
class="kw">await</span>.unwrap_err().to_string(),
+ <span class="macro">format!</span>(
+ <span class="string">"DataInvalid => Given string is not
valid JSON, source: invalid value: integer `{}`, expected i32 at line 5 column
51"</span>,
+ out_of_i32_range_number
+ ),
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_returns_errors_if_footer_payload_is_not_encoded_in_json_format() {
+ <span class="kw">let </span>temp_dir = TempDir::new().unwrap();
+
+ <span class="kw">let </span>input_file = input_file_with_payload(<span
class="kw-2">&</span>temp_dir, <span class="string">r#""blobs" =
[]"#</span>).<span class="kw">await</span>;
+ <span class="macro">assert_eq!</span>(
+ FileMetadata::read(<span
class="kw-2">&</span>input_file).<span
class="kw">await</span>.unwrap_err().to_string(),
+ <span class="string">"DataInvalid => Given string is not valid
JSON, source: invalid type: string \"blobs\", expected struct FileMetadata at
line 1 column 7"</span>,
+ )
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_read_file_metadata_of_uncompressed_empty_file() {
+ <span class="kw">let </span>input_file =
java_empty_uncompressed_input_file();
+ <span class="kw">let </span>file_metadata = FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap();
+ <span class="macro">assert_eq!</span>(file_metadata,
empty_footer_payload())
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_read_file_metadata_of_uncompressed_metric_data() {
+ <span class="kw">let </span>input_file =
java_uncompressed_metric_input_file();
+ <span class="kw">let </span>file_metadata = FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap();
+ <span class="macro">assert_eq!</span>(file_metadata,
uncompressed_metric_file_metadata())
+ }
+
+ <span class="attr">#[tokio::test]
+ </span><span class="kw">async fn
</span>test_read_file_metadata_of_zstd_compressed_metric_data() {
+ <span class="kw">let </span>input_file =
java_zstd_compressed_metric_input_file();
+ <span class="kw">let </span>file_metadata = FileMetadata::read(<span
class="kw-2">&</span>input_file).<span class="kw">await</span>.unwrap();
+ <span class="macro">assert_eq!</span>(file_metadata,
zstd_compressed_metric_file_metadata())
+ }
+}
+</code></pre></div></section></main></body></html>
\ No newline at end of file
diff --git a/api/src/iceberg/puffin/mod.rs.html
b/api/src/iceberg/puffin/mod.rs.html
index edef5cd4..5a9d4483 100644
--- a/api/src/iceberg/puffin/mod.rs.html
+++ b/api/src/iceberg/puffin/mod.rs.html
@@ -22,6 +22,10 @@
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
+<a href="#25" id="25">25</a>
+<a href="#26" id="26">26</a>
+<a href="#27" id="27">27</a>
+<a href="#28" id="28">28</a>
</pre></div><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
@@ -46,4 +50,8 @@
</span><span class="attr">#![allow(dead_code)]
</span><span class="kw">mod </span>compression;
+<span class="kw">mod </span>metadata;
+
+<span class="attr">#[cfg(test)]
+</span><span class="kw">mod </span>test_utils;
</code></pre></div></section></main></body></html>
\ No newline at end of file
