Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-enclave / src / fastfield_codecs / null_index_footer.rs.html
blob: 3cdea37cabc5956456f06aa7de858f0d676cc30f [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/.cargo/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/fastfield_codecs/src/null_index_footer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>null_index_footer.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="../../fastfield_codecs/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="../../fastfield_codecs/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>
</pre><pre class="rust"><code><span class="kw">use </span>std::io::{<span class="self">self</span>, Write};
<span class="kw">use </span>std::ops::Range;
<span class="kw">use </span>common::{BinarySerializable, CountingWriter, VInt};
<span class="kw">use </span>ownedbytes::OwnedBytes;
<span class="attribute">#[derive(Debug, Clone, Copy, Eq, PartialEq)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>FastFieldCardinality {
Single = <span class="number">1</span>,
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>FastFieldCardinality {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, wrt: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.to_code().serialize(wrt)
}
<span class="kw">fn </span>deserialize&lt;R: io::Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>code = u8::deserialize(reader)<span class="question-mark">?</span>;
<span class="kw">let </span>codec_type: <span class="self">Self </span>= <span class="self">Self</span>::from_code(code)
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidData, <span class="string">&quot;Unknown code `{code}.`&quot;</span>))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(codec_type)
}
}
<span class="kw">impl </span>FastFieldCardinality {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>to_code(<span class="self">self</span>) -&gt; u8 {
<span class="self">self </span><span class="kw">as </span>u8
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_code(code: u8) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>&gt; {
<span class="kw">match </span>code {
<span class="number">1 </span>=&gt; <span class="prelude-val">Some</span>(<span class="self">Self</span>::Single),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>NullIndexCodec {
Full = <span class="number">1</span>,
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>NullIndexCodec {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, wrt: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.to_code().serialize(wrt)
}
<span class="kw">fn </span>deserialize&lt;R: io::Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>code = u8::deserialize(reader)<span class="question-mark">?</span>;
<span class="kw">let </span>codec_type: <span class="self">Self </span>= <span class="self">Self</span>::from_code(code)
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidData, <span class="string">&quot;Unknown code `{code}.`&quot;</span>))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(codec_type)
}
}
<span class="kw">impl </span>NullIndexCodec {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>to_code(<span class="self">self</span>) -&gt; u8 {
<span class="self">self </span><span class="kw">as </span>u8
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_code(code: u8) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>&gt; {
<span class="kw">match </span>code {
<span class="number">1 </span>=&gt; <span class="prelude-val">Some</span>(<span class="self">Self</span>::Full),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="attribute">#[derive(Debug, Clone, Eq, PartialEq)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>NullIndexFooter {
<span class="kw">pub</span>(<span class="kw">crate</span>) cardinality: FastFieldCardinality,
<span class="kw">pub</span>(<span class="kw">crate</span>) null_index_codec: NullIndexCodec,
<span class="comment">// Unused for NullIndexCodec::Full
</span><span class="kw">pub</span>(<span class="kw">crate</span>) null_index_byte_range: Range&lt;u64&gt;,
}
<span class="kw">impl </span>BinarySerializable <span class="kw">for </span>NullIndexFooter {
<span class="kw">fn </span>serialize&lt;W: Write&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, writer: <span class="kw-2">&amp;mut </span>W) -&gt; io::Result&lt;()&gt; {
<span class="self">self</span>.cardinality.serialize(writer)<span class="question-mark">?</span>;
<span class="self">self</span>.null_index_codec.serialize(writer)<span class="question-mark">?</span>;
VInt(<span class="self">self</span>.null_index_byte_range.start).serialize(writer)<span class="question-mark">?</span>;
VInt(<span class="self">self</span>.null_index_byte_range.end - <span class="self">self</span>.null_index_byte_range.start)
.serialize(writer)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>deserialize&lt;R: io::Read&gt;(reader: <span class="kw-2">&amp;mut </span>R) -&gt; io::Result&lt;<span class="self">Self</span>&gt; {
<span class="kw">let </span>cardinality = FastFieldCardinality::deserialize(reader)<span class="question-mark">?</span>;
<span class="kw">let </span>null_index_codec = NullIndexCodec::deserialize(reader)<span class="question-mark">?</span>;
<span class="kw">let </span>null_index_byte_range_start = VInt::deserialize(reader)<span class="question-mark">?</span>.<span class="number">0</span>;
<span class="kw">let </span>null_index_byte_range_end = VInt::deserialize(reader)<span class="question-mark">?</span>.<span class="number">0 </span>+ null_index_byte_range_start;
<span class="prelude-val">Ok</span>(<span class="self">Self </span>{
cardinality,
null_index_codec,
null_index_byte_range: null_index_byte_range_start..null_index_byte_range_end,
})
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>append_null_index_footer(
output: <span class="kw-2">&amp;mut </span><span class="kw">impl </span>io::Write,
null_index_footer: NullIndexFooter,
) -&gt; io::Result&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>counting_write = CountingWriter::wrap(output);
null_index_footer.serialize(<span class="kw-2">&amp;mut </span>counting_write)<span class="question-mark">?</span>;
<span class="kw">let </span>footer_payload_len = counting_write.written_bytes();
BinarySerializable::serialize(<span class="kw-2">&amp;</span>(footer_payload_len <span class="kw">as </span>u16), <span class="kw-2">&amp;mut </span>counting_write)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>read_null_index_footer(
data: OwnedBytes,
) -&gt; io::Result&lt;(OwnedBytes, NullIndexFooter)&gt; {
<span class="kw">let </span>(data, null_footer_length_bytes) = data.rsplit(<span class="number">2</span>);
<span class="kw">let </span>footer_length = u16::deserialize(<span class="kw-2">&amp;mut </span>null_footer_length_bytes.as_slice())<span class="question-mark">?</span>;
<span class="kw">let </span>(data, null_index_footer_bytes) = data.rsplit(footer_length <span class="kw">as </span>usize);
<span class="kw">let </span>null_index_footer = NullIndexFooter::deserialize(<span class="kw-2">&amp;mut </span>null_index_footer_bytes.as_ref())<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>((data, null_index_footer))
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>null_index_footer_deser_test() {
<span class="kw">let </span>null_index_footer = NullIndexFooter {
cardinality: FastFieldCardinality::Single,
null_index_codec: NullIndexCodec::Full,
null_index_byte_range: <span class="number">100</span>..<span class="number">120</span>,
};
<span class="kw">let </span><span class="kw-2">mut </span>out = <span class="macro">vec!</span>[];
null_index_footer.serialize(<span class="kw-2">&amp;mut </span>out).unwrap();
<span class="macro">assert_eq!</span>(
null_index_footer,
NullIndexFooter::deserialize(<span class="kw-2">&amp;mut &amp;</span>out[..]).unwrap()
);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="fastfield_codecs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>