mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-19 22:40:40 +00:00
71 lines
16 KiB
HTML
71 lines
16 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="`InvertedIndexCreator` provides functionality to construct an inverted index"><title>InvertedIndexCreator in index::inverted_index::create - 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-e56847b5.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.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.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"><!--[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="#">InvertedIndexCreator</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-rc.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Inverted<wbr>Index<wbr>Creator</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.finish" title="finish">finish</a></li><li><a href="#tymethod.push_with_name_n" title="push_with_name_n">push_with_name_n</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.push_with_name" title="push_with_name">push_with_name</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>create</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"><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">create</a></div><h1>Trait <span class="trait">Inverted<wbr>Index<wbr>Creator</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/create.rs.html#27-62">Source</a> </span></div><pre class="rust item-decl"><code>pub trait InvertedIndexCreator: <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.push_with_name_n" class="fn">push_with_name_n</a><'life0, 'life1, 'life2, 'async_trait>(
|
|
&'life0 mut self,
|
|
index_name: &'life1 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="../../type.BytesRef.html" title="type index::BytesRef">BytesRef</a><'life2>>,
|
|
n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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,
|
|
'life1: 'async_trait,
|
|
'life2: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.finish" class="fn">finish</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 mut self,
|
|
writer: &'life1 mut dyn <a class="trait" href="../format/writer/trait.InvertedIndexWriter.html" title="trait index::inverted_index::format::writer::InvertedIndexWriter">InvertedIndexWriter</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,
|
|
'life1: 'async_trait</span>;
|
|
|
|
// Provided method
|
|
fn <a href="#method.push_with_name" class="fn">push_with_name</a><'life0, 'life1, 'life2, 'async_trait>(
|
|
&'life0 mut self,
|
|
index_name: &'life1 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="../../type.BytesRef.html" title="type index::BytesRef">BytesRef</a><'life2>>,
|
|
) -> <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,
|
|
'life1: 'async_trait,
|
|
'life2: 'async_trait</span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>InvertedIndexCreator</code> provides functionality to construct an inverted index</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.push_with_name_n" class="method"><a class="src rightside" href="../../../src/index/inverted_index/create.rs.html#48-53">Source</a><h4 class="code-header">fn <a href="#tymethod.push_with_name_n" class="fn">push_with_name_n</a><'life0, 'life1, 'life2, 'async_trait>(
|
|
&'life0 mut self,
|
|
index_name: &'life1 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="../../type.BytesRef.html" title="type index::BytesRef">BytesRef</a><'life2>>,
|
|
n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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,
|
|
'life1: 'async_trait,
|
|
'life2: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Adds <code>n</code> identical values to the named index. <code>None</code> values represent absence of data (null)</p>
|
|
<ul>
|
|
<li><code>index_name</code>: Identifier for the index being built</li>
|
|
<li><code>value</code>: The data to be indexed, or <code>None</code> for a null entry</li>
|
|
</ul>
|
|
<p>It should be equivalent to calling <code>push_with_name</code> <code>n</code> times</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.finish" class="method"><a class="src rightside" href="../../../src/index/inverted_index/create.rs.html#57-61">Source</a><h4 class="code-header">fn <a href="#tymethod.finish" class="fn">finish</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 mut self,
|
|
writer: &'life1 mut dyn <a class="trait" href="../format/writer/trait.InvertedIndexWriter.html" title="trait index::inverted_index::format::writer::InvertedIndexWriter">InvertedIndexWriter</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,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Finalizes the index creation process, ensuring all data is properly indexed and stored
|
|
in the provided writer</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.push_with_name" class="method"><a class="src rightside" href="../../../src/index/inverted_index/create.rs.html#34-40">Source</a><h4 class="code-header">fn <a href="#method.push_with_name" class="fn">push_with_name</a><'life0, 'life1, 'life2, 'async_trait>(
|
|
&'life0 mut self,
|
|
index_name: &'life1 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
|
value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="../../type.BytesRef.html" title="type index::BytesRef">BytesRef</a><'life2>>,
|
|
) -> <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,
|
|
'life1: 'async_trait,
|
|
'life2: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Adds a value to the named index. A <code>None</code> value represents an absence of data (null)</p>
|
|
<ul>
|
|
<li><code>index_name</code>: Identifier for the index being built</li>
|
|
<li><code>value</code>: The data to be indexed, or <code>None</code> for a null entry</li>
|
|
</ul>
|
|
<p>It should be equivalent to calling <code>push_with_name_n</code> with <code>n = 1</code></p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-InvertedIndexCreator-for-SortIndexCreator" class="impl"><a class="src rightside" href="../../../src/index/inverted_index/create/sort_create.rs.html#48-104">Source</a><a href="#impl-InvertedIndexCreator-for-SortIndexCreator" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.InvertedIndexCreator.html" title="trait index::inverted_index::create::InvertedIndexCreator">InvertedIndexCreator</a> for <a class="struct" href="sort_create/struct.SortIndexCreator.html" title="struct index::inverted_index::create::sort_create::SortIndexCreator">SortIndexCreator</a></h3></section></div><script src="../../../trait.impl/index/inverted_index/create/trait.InvertedIndexCreator.js" async></script></section></div></main></body></html> |