| <!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="Column oriented field storage for tantivy."><meta name="keywords" content="rust, rustlang, rust-lang, fastfield"><title>tantivy::fastfield - 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="../../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"><!--[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="../../tantivy/index.html"><div class="logo-container"><img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">Module fastfield</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</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">Module <a href="../index.html">tantivy</a>::<wbr><a class="mod" href="#">fastfield</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/tantivy/fastfield/mod.rs.html#1-1087">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"><p>Column oriented field storage for tantivy.</p> |
| <p>It is the equivalent of <code>Lucene</code>’s <code>DocValues</code>.</p> |
| <p>A fast field is a column-oriented fashion storage for <code>tantivy</code>.</p> |
| <p>It is designed for the fast random access of some document |
| fields given a document id.</p> |
| <p>Fast fields are useful when a field is required for all or most of |
| the <code>DocSet</code>: for instance for scoring, grouping, aggregation, filtering, or faceting.</p> |
| <p>Fields have to be declared as <code>FAST</code> in the schema. |
| Currently supported fields are: u64, i64, f64, bytes and text.</p> |
| <p>Fast fields are stored in with <a href="../../fastfield_codecs/index.html">different codecs</a>. The best codec is detected |
| automatically, when serializing.</p> |
| <p>Read access performance is comparable to that of an array lookup.</p> |
| </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.AliveBitSet.html" title="tantivy::fastfield::AliveBitSet struct">AliveBitSet</a></div><div class="item-right docblock-short">Set of alive <code>DocId</code>s.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BytesFastFieldReader.html" title="tantivy::fastfield::BytesFastFieldReader struct">BytesFastFieldReader</a></div><div class="item-right docblock-short">Reader for byte array fast fields</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BytesFastFieldWriter.html" title="tantivy::fastfield::BytesFastFieldWriter struct">BytesFastFieldWriter</a></div><div class="item-right docblock-short">Writer for byte array (as in, any number of bytes per document) fast fields</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CompositeFastFieldSerializer.html" title="tantivy::fastfield::CompositeFastFieldSerializer struct">CompositeFastFieldSerializer</a></div><div class="item-right docblock-short"><code>CompositeFastFieldSerializer</code> is in charge of serializing |
| fastfields on disk.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FacetReader.html" title="tantivy::fastfield::FacetReader struct">FacetReader</a></div><div class="item-right docblock-short">The facet reader makes it possible to access the list of |
| facets associated with a given document in a specific |
| segment.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FastFieldNotAvailableError.html" title="tantivy::fastfield::FastFieldNotAvailableError struct">FastFieldNotAvailableError</a></div><div class="item-right docblock-short"><code>FastFieldNotAvailableError</code> is returned when the |
| user requested for a fast field reader, and the field was not |
| defined in the schema as a fast field.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FastFieldReaders.html" title="tantivy::fastfield::FastFieldReaders struct">FastFieldReaders</a></div><div class="item-right docblock-short">Provides access to all of the BitpackedFastFieldReader.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FastFieldsWriter.html" title="tantivy::fastfield::FastFieldsWriter struct">FastFieldsWriter</a></div><div class="item-right docblock-short">The <code>FastFieldsWriter</code> groups all of the fast field writers.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntFastFieldWriter.html" title="tantivy::fastfield::IntFastFieldWriter struct">IntFastFieldWriter</a></div><div class="item-right docblock-short">Fast field writer for ints. |
| The fast field writer just keeps the values in memory.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiValueIndex.html" title="tantivy::fastfield::MultiValueIndex struct">MultiValueIndex</a></div><div class="item-right docblock-short">Index to resolve value range for given doc_id. |
| Starts at 0.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiValueU128FastFieldWriter.html" title="tantivy::fastfield::MultiValueU128FastFieldWriter struct">MultiValueU128FastFieldWriter</a></div><div class="item-right docblock-short">Writer for multi-valued (as in, more than one value per document) |
| int fast field.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiValuedFastFieldReader.html" title="tantivy::fastfield::MultiValuedFastFieldReader struct">MultiValuedFastFieldReader</a></div><div class="item-right docblock-short">Reader for a multivalued <code>u64</code> fast field.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiValuedFastFieldWriter.html" title="tantivy::fastfield::MultiValuedFastFieldWriter struct">MultiValuedFastFieldWriter</a></div><div class="item-right docblock-short">Writer for multi-valued (as in, more than one value per document) |
| int fast field.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiValuedU128FastFieldReader.html" title="tantivy::fastfield::MultiValuedU128FastFieldReader struct">MultiValuedU128FastFieldReader</a></div><div class="item-right docblock-short">Reader for a multivalued <code>u128</code> fast field.</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.FastFieldType.html" title="tantivy::fastfield::FastFieldType enum">FastFieldType</a></div><div class="item-right docblock-short">The fast field type</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="tantivy::fastfield::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.FastValue.html" title="tantivy::fastfield::FastValue trait">FastValue</a></div><div class="item-right docblock-short">Trait for types that are allowed for fast fields: |
| (u64, i64 and f64, bool, DateTime).</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.intersect_alive_bitsets.html" title="tantivy::fastfield::intersect_alive_bitsets fn">intersect_alive_bitsets</a></div><div class="item-right docblock-short">Intersects two AliveBitSets in a new one. |
| The two bitsets need to have the same max_value.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.write_alive_bitset.html" title="tantivy::fastfield::write_alive_bitset fn">write_alive_bitset</a></div><div class="item-right docblock-short">Write an alive <code>BitSet</code></div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Result.html" title="tantivy::fastfield::Result type">Result</a></div><div class="item-right docblock-short">Result when trying to access a fast field reader.</div></div></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> |
