| <!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="Compressed/slow/row-oriented storage for documents."><meta name="keywords" content="rust, rustlang, rust-lang, store"><title>tantivy::store - 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 store</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</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="#">store</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/store/mod.rs.html#1-409">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>Compressed/slow/row-oriented storage for documents.</p> |
| <p>A field needs to be marked as stored in the schema in |
| order to be handled in the <code>Store</code>.</p> |
| <p>Internally, documents (or rather their stored fields) are serialized to a buffer. |
| When the buffer exceeds 16K, the buffer is compressed using <code>brotli</code>, <code>LZ4</code> or <code>snappy</code> |
| and the resulting block is written to disk.</p> |
| <p>One can then request for a specific <code>DocId</code>. |
| A skip list helps navigating to the right block, |
| decompresses it entirely and returns the document within it.</p> |
| <p>If the last document requested was in the same block, |
| the reader is smart enough to avoid decompressing |
| the block a second time, but their is no real |
| uncompressed block* cache.</p> |
| <p>A typical use case for the store is, once |
| the search result page has been computed, returning |
| the actual content of the 10 best document.</p> |
| <h2 id="usage"><a href="#usage">Usage</a></h2> |
| <p>Most users should not access the <code>StoreReader</code> directly |
| and should rely on either</p> |
| <ul> |
| <li>at the segment level, the |
| <a href="../struct.SegmentReader.html#method.doc"><code>SegmentReader</code>’s <code>doc</code> method</a></li> |
| <li>at the index level, the <a href="../struct.Searcher.html#method.doc"><code>Searcher::doc()</code></a> method</li> |
| </ul> |
| <p>!</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.CacheStats.html" title="tantivy::store::CacheStats struct">CacheStats</a></div><div class="item-right docblock-short">CacheStats for the <code>StoreReader</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StoreReader.html" title="tantivy::store::StoreReader struct">StoreReader</a></div><div class="item-right docblock-short">Reads document off tantivy’s <a href="./index.html"><code>Store</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.StoreWriter.html" title="tantivy::store::StoreWriter struct">StoreWriter</a></div><div class="item-right docblock-short">Write tantivy’s <a href="./index.html"><code>Store</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ZstdCompressor.html" title="tantivy::store::ZstdCompressor struct">ZstdCompressor</a></div><div class="item-right docblock-short">The Zstd compressor, with optional compression level.</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.Compressor.html" title="tantivy::store::Compressor enum">Compressor</a></div><div class="item-right docblock-short">Compressor can be used on <code>IndexSettings</code> to choose |
| the compressor used to compress the doc store.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Decompressor.html" title="tantivy::store::Decompressor enum">Decompressor</a></div><div class="item-right docblock-short">Decompressor is deserialized from the doc store footer, when opening an index.</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> |
