| <!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/src/fastfield/serializer/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="../../../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tantivy/index.html"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" 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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io::{<span class="self">self</span>, Write}; |
| |
| <span class="kw">pub use </span>fastfield_codecs::Column; |
| <span class="kw">use </span>fastfield_codecs::{FastFieldCodecType, MonotonicallyMappableToU64, ALL_CODEC_TYPES}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::directory::{CompositeWrite, WritePtr}; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::Field; |
| |
| <span class="doccomment">/// `CompositeFastFieldSerializer` is in charge of serializing |
| /// fastfields on disk. |
| /// |
| /// Fast fields have different encodings like bit-packing. |
| /// |
| /// `FastFieldWriter`s are in charge of pushing the data to |
| /// the serializer. |
| /// The serializer expects to receive the following calls. |
| /// |
| /// * `create_auto_detect_u64_fast_field(...)` |
| /// * `create_auto_detect_u64_fast_field(...)` |
| /// * ... |
| /// * `let bytes_fastfield = new_bytes_fast_field(...)` |
| /// * `bytes_fastfield.write_all(...)` |
| /// * `bytes_fastfield.write_all(...)` |
| /// * `bytes_fastfield.flush()` |
| /// * ... |
| /// * `close()` |
| </span><span class="kw">pub struct </span>CompositeFastFieldSerializer { |
| composite_write: CompositeWrite<WritePtr>, |
| codec_types: Vec<FastFieldCodecType>, |
| } |
| |
| <span class="kw">impl </span>CompositeFastFieldSerializer { |
| <span class="doccomment">/// New fast field serializer with all codec types |
| </span><span class="kw">pub fn </span>from_write(write: WritePtr) -> io::Result<CompositeFastFieldSerializer> { |
| <span class="self">Self</span>::from_write_with_codec(write, <span class="kw-2">&</span>ALL_CODEC_TYPES) |
| } |
| |
| <span class="doccomment">/// New fast field serializer with allowed codec types |
| </span><span class="kw">pub fn </span>from_write_with_codec( |
| write: WritePtr, |
| codec_types: <span class="kw-2">&</span>[FastFieldCodecType], |
| ) -> io::Result<CompositeFastFieldSerializer> { |
| <span class="kw">let </span>composite_write = CompositeWrite::wrap(write); |
| <span class="prelude-val">Ok</span>(CompositeFastFieldSerializer { |
| composite_write, |
| codec_types: codec_types.to_vec(), |
| }) |
| } |
| |
| <span class="doccomment">/// Serialize data into a new u64 fast field. The best compression codec will be chosen |
| /// automatically. |
| </span><span class="kw">pub fn </span>create_auto_detect_u64_fast_field<T: MonotonicallyMappableToU64 + fmt::Debug>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| field: Field, |
| fastfield_accessor: <span class="kw">impl </span>Column<T>, |
| ) -> io::Result<()> { |
| <span class="self">self</span>.create_auto_detect_u64_fast_field_with_idx(field, fastfield_accessor, <span class="number">0</span>) |
| } |
| |
| <span class="doccomment">/// Serialize data into a new u64 fast field. The best compression codec will be chosen |
| /// automatically. |
| </span><span class="kw">pub fn </span>create_auto_detect_u64_fast_field_with_idx< |
| T: MonotonicallyMappableToU64 + fmt::Debug, |
| >( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| field: Field, |
| fastfield_accessor: <span class="kw">impl </span>Column<T>, |
| idx: usize, |
| ) -> io::Result<()> { |
| <span class="kw">let </span>field_write = <span class="self">self</span>.composite_write.for_field_with_idx(field, idx); |
| fastfield_codecs::serialize(fastfield_accessor, field_write, <span class="kw-2">&</span><span class="self">self</span>.codec_types)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="doccomment">/// Serialize data into a new u64 fast field. The best compression codec of the the provided |
| /// will be chosen. |
| </span><span class="kw">pub fn </span>create_auto_detect_u64_fast_field_with_idx_and_codecs< |
| T: MonotonicallyMappableToU64 + fmt::Debug, |
| >( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| field: Field, |
| fastfield_accessor: <span class="kw">impl </span>Column<T>, |
| idx: usize, |
| codec_types: <span class="kw-2">&</span>[FastFieldCodecType], |
| ) -> io::Result<()> { |
| <span class="kw">let </span>field_write = <span class="self">self</span>.composite_write.for_field_with_idx(field, idx); |
| fastfield_codecs::serialize(fastfield_accessor, field_write, codec_types)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="doccomment">/// Serialize data into a new u128 fast field. The codec will be compact space compressor, |
| /// which is optimized for scanning the fast field for a given range. |
| </span><span class="kw">pub fn </span>create_u128_fast_field_with_idx<F: Fn() -> I, I: Iterator<Item = u128>>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| field: Field, |
| iter_gen: F, |
| num_vals: u32, |
| idx: usize, |
| ) -> io::Result<()> { |
| <span class="kw">let </span>field_write = <span class="self">self</span>.composite_write.for_field_with_idx(field, idx); |
| fastfield_codecs::serialize_u128(iter_gen, num_vals, field_write)<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="doccomment">/// Start serializing a new [u8] fast field. Use the returned writer to write data into the |
| /// bytes field. To associate the bytes with documents a seperate index must be created on |
| /// index 0. See bytes/writer.rs::serialize for an example. |
| /// |
| /// The bytes will be stored as is, no compression will be applied. |
| </span><span class="kw">pub fn </span>new_bytes_fast_field(<span class="kw-2">&mut </span><span class="self">self</span>, field: Field) -> <span class="kw">impl </span>Write + <span class="lifetime">'_ </span>{ |
| <span class="self">self</span>.composite_write.for_field_with_idx(field, <span class="number">1</span>) |
| } |
| |
| <span class="doccomment">/// Closes the serializer |
| /// |
| /// After this call the data must be persistently saved on disk. |
| </span><span class="kw">pub fn </span>close(<span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.composite_write.close() |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |