| <!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="`fastfield_codecs`"><meta name="keywords" content="rust, rustlang, rust-lang, fastfield_codecs"><title>fastfield_codecs - Rust</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="../crates.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 mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><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><h2></h2></nav><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><h2 class="location"><a href="#">Crate fastfield_codecs</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.3.1</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">fastfield_codecs</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/fastfield_codecs/lib.rs.html#1-567">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="fastfield_codecs"><a href="#fastfield_codecs"><code>fastfield_codecs</code></a></h2> |
| <ul> |
| <li>Columnar storage of data for tantivy <a href="trait.Column.html" title="Column"><code>Column</code></a>.</li> |
| <li>Encode data in different codecs.</li> |
| <li>Monotonically map values to u64/u128</li> |
| </ul> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IterColumn.html" title="fastfield_codecs::IterColumn struct">IterColumn</a></div><div class="item-right docblock-short">Wraps an iterator into a <code>Column</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NormalizedHeader.html" title="fastfield_codecs::NormalizedHeader struct">NormalizedHeader</a></div><div class="item-right docblock-short">The normalized header gives some parameters after applying the following |
| normalization of the vector: |
| <code>val -> (val - min_value) / gcd</code></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VecColumn.html" title="fastfield_codecs::VecColumn struct">VecColumn</a></div><div class="item-right docblock-short">VecColumn provides <code>Column</code> over a slice.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.FastFieldCodecType.html" title="fastfield_codecs::FastFieldCodecType enum">FastFieldCodecType</a></div><div class="item-right docblock-short">Available codecs to use to encode the u64 (via <a href="trait.MonotonicallyMappableToU64.html" title="MonotonicallyMappableToU64"><code>MonotonicallyMappableToU64</code></a>) converted data.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.U128FastFieldCodecType.html" title="fastfield_codecs::U128FastFieldCodecType enum">U128FastFieldCodecType</a></div><div class="item-right docblock-short">Available codecs to use to encode the u128 (via <a href="trait.MonotonicallyMappableToU128.html" title="MonotonicallyMappableToU128"><code>MonotonicallyMappableToU128</code></a>) converted data.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.ALL_CODEC_TYPES.html" title="fastfield_codecs::ALL_CODEC_TYPES constant">ALL_CODEC_TYPES</a></div><div class="item-right docblock-short">The list of all available codecs for u64 convertible data.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Column.html" title="fastfield_codecs::Column trait">Column</a></div><div class="item-right docblock-short"><code>Column</code> provides columnar access on a field.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.MonotonicallyMappableToU64.html" title="fastfield_codecs::MonotonicallyMappableToU64 trait">MonotonicallyMappableToU64</a></div><div class="item-right docblock-short">Monotonic maps a value to u64 value space. |
| Monotonic mapping enables <code>PartialOrd</code> on u64 space without conversion to original space.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.MonotonicallyMappableToU128.html" title="fastfield_codecs::MonotonicallyMappableToU128 trait">MonotonicallyMappableToU128</a></div><div class="item-right docblock-short">Montonic maps a value to u128 value space |
| Monotonic mapping enables <code>PartialOrd</code> on u128 space without conversion to original space.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.StrictlyMonotonicFn.html" title="fastfield_codecs::StrictlyMonotonicFn trait">StrictlyMonotonicFn</a></div><div class="item-right docblock-short">Values need to be strictly monotonic mapped to a <code>Internal</code> value (u64 or u128) that can be |
| used in fast field codecs.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.estimate.html" title="fastfield_codecs::estimate fn">estimate</a></div><div class="item-right docblock-short">Return estimated compression for given codec in the value range [0.0..1.0], where 1.0 means no |
| compression.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.monotonic_map_column.html" title="fastfield_codecs::monotonic_map_column fn">monotonic_map_column</a></div><div class="item-right docblock-short">Creates a view of a column transformed by a strictly monotonic mapping. See |
| <a href="trait.StrictlyMonotonicFn.html" title="StrictlyMonotonicFn"><code>StrictlyMonotonicFn</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.open.html" title="fastfield_codecs::open fn">open</a></div><div class="item-right docblock-short">Returns the correct codec reader wrapped in the <code>Arc</code> for the data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.open_u128.html" title="fastfield_codecs::open_u128 fn">open_u128</a></div><div class="item-right docblock-short">Returns the correct codec reader wrapped in the <code>Arc</code> for the data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize.html" title="fastfield_codecs::serialize fn">serialize</a></div><div class="item-right docblock-short">Serializes the column with the codec with the best estimate on the data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_and_load.html" title="fastfield_codecs::serialize_and_load fn">serialize_and_load</a></div><div class="item-right docblock-short">Helper function to serialize a column (autodetect from all codecs) and then open it</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_u128.html" title="fastfield_codecs::serialize_u128 fn">serialize_u128</a></div><div class="item-right docblock-short">Serializes u128 values with the compact space codec.</div></div></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> |
