mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-31 04:10:38 +00:00
45 lines
13 KiB
HTML
45 lines
13 KiB
HTML
<!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="Trait for writing inverted index data to underlying storage."><title>InvertedIndexWriter in index::inverted_index::format::writer - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="index" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../../static.files/storage-41dd4d93.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">InvertedIndexWriter</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../index/index.html">index</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Inverted<wbr>Index<wbr>Writer</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.add_index" title="add_index">add_index</a></li><li><a href="#tymethod.finish" title="finish">finish</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In index::<wbr>inverted_<wbr>index::<wbr>format::<wbr>writer</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">index</a>::<wbr><a href="../../index.html">inverted_index</a>::<wbr><a href="../index.html">format</a>::<wbr><a href="index.html">writer</a></div><h1>Trait <span class="trait">Inverted<wbr>Index<wbr>Writer</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../../src/index/inverted_index/format/writer.rs.html#33-53">Source</a> </span></div><pre class="rust item-decl"><code>pub trait InvertedIndexWriter: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.add_index" class="fn">add_index</a><'life0, 'async_trait>(
|
|
&'life0 mut self,
|
|
name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
|
null_bitmap: <a class="enum" href="../../../bitmap/enum.Bitmap.html" title="enum index::bitmap::Bitmap">Bitmap</a>,
|
|
values: <a class="type" href="type.ValueStream.html" title="type index::inverted_index::format::writer::ValueStream">ValueStream</a>,
|
|
bitmap_type: <a class="enum" href="../../../bitmap/enum.BitmapType.html" title="enum index::bitmap::BitmapType">BitmapType</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="../../error/type.Result.html" title="type index::inverted_index::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.finish" class="fn">finish</a><'life0, 'async_trait>(
|
|
&'life0 mut self,
|
|
total_row_count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
segment_row_count: <a class="type" href="https://doc.rust-lang.org/nightly/core/num/nonzero/type.NonZeroUsize.html" title="type core::num::nonzero::NonZeroUsize">NonZeroUsize</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="../../error/type.Result.html" title="type index::inverted_index::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for writing inverted index data to underlying storage.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.add_index" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/writer.rs.html#41-47">Source</a><h4 class="code-header">fn <a href="#tymethod.add_index" class="fn">add_index</a><'life0, 'async_trait>(
|
|
&'life0 mut self,
|
|
name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
|
null_bitmap: <a class="enum" href="../../../bitmap/enum.Bitmap.html" title="enum index::bitmap::Bitmap">Bitmap</a>,
|
|
values: <a class="type" href="type.ValueStream.html" title="type index::inverted_index::format::writer::ValueStream">ValueStream</a>,
|
|
bitmap_type: <a class="enum" href="../../../bitmap/enum.BitmapType.html" title="enum index::bitmap::BitmapType">BitmapType</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="../../error/type.Result.html" title="type index::inverted_index::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Adds entries to an index.</p>
|
|
<ul>
|
|
<li><code>name</code> is the index identifier.</li>
|
|
<li><code>null_bitmap</code> marks positions of null entries.</li>
|
|
<li><code>values</code> is a stream of values and their locations, yielded lexicographically.
|
|
Errors occur if the values are out of order.</li>
|
|
<li><code>bitmap_type</code> is the type of bitmap to encode.</li>
|
|
</ul>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.finish" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/writer.rs.html#51-52">Source</a><h4 class="code-header">fn <a href="#tymethod.finish" class="fn">finish</a><'life0, 'async_trait>(
|
|
&'life0 mut self,
|
|
total_row_count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
segment_row_count: <a class="type" href="https://doc.rust-lang.org/nightly/core/num/nonzero/type.NonZeroUsize.html" title="type core::num::nonzero::NonZeroUsize">NonZeroUsize</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="type" href="../../error/type.Result.html" title="type index::inverted_index::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Finalizes the index writing process, ensuring all data is written.
|
|
<code>total_row_count</code> and <code>segment_row_count</code> is used to fill in the metadata.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-InvertedIndexWriter-for-MockInvertedIndexWriter" class="impl"><a class="src rightside" href="../../../../src/index/inverted_index/format/writer.rs.html#31">Source</a><a href="#impl-InvertedIndexWriter-for-MockInvertedIndexWriter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.InvertedIndexWriter.html" title="trait index::inverted_index::format::writer::InvertedIndexWriter">InvertedIndexWriter</a> for <a class="struct" href="struct.MockInvertedIndexWriter.html" title="struct index::inverted_index::format::writer::MockInvertedIndexWriter">MockInvertedIndexWriter</a></h3><div class="docblock"><p>Trait for writing inverted index data to underlying storage.</p>
|
|
</div></section><section id="impl-InvertedIndexWriter-for-InvertedIndexBlobWriter%3CW%3E" class="impl"><a class="src rightside" href="../../../../src/index/inverted_index/format/writer/blob.rs.html#42-90">Source</a><a href="#impl-InvertedIndexWriter-for-InvertedIndexBlobWriter%3CW%3E" class="anchor">§</a><h3 class="code-header">impl<W: AsyncWrite + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.InvertedIndexWriter.html" title="trait index::inverted_index::format::writer::InvertedIndexWriter">InvertedIndexWriter</a> for <a class="struct" href="struct.InvertedIndexBlobWriter.html" title="struct index::inverted_index::format::writer::InvertedIndexBlobWriter">InvertedIndexBlobWriter</a><W></h3></section></div><script src="../../../../trait.impl/index/inverted_index/format/writer/trait.InvertedIndexWriter.js" async></script></section></div></main></body></html> |