mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-20 06:50:37 +00:00
131 lines
33 KiB
HTML
131 lines
33 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="InvertedIndexReader defines an asynchronous reader of inverted index data"><title>InvertedIndexReader in index::inverted_index::format::reader - 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="#">InvertedIndexReader</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>Reader</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.metadata" title="metadata">metadata</a></li><li><a href="#tymethod.range_read" title="range_read">range_read</a></li><li><a href="#tymethod.read_vec" title="read_vec">read_vec</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.bitmap" title="bitmap">bitmap</a></li><li><a href="#method.bitmap_deque" title="bitmap_deque">bitmap_deque</a></li><li><a href="#method.fst" title="fst">fst</a></li><li><a href="#method.fst_vec" title="fst_vec">fst_vec</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>reader</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">format</a>::<wbr><a href="index.html">reader</a></div><h1>Trait <span class="trait">Inverted<wbr>Index<wbr>Reader</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/reader.rs.html#102-179">Source</a> </span></div><pre class="rust item-decl"><code>pub trait InvertedIndexReader: <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.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.range_read" class="fn">range_read</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.read_vec" class="fn">read_vec</a><'a, 'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
ranges: &'life1 [<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>],
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Bytes>>> + <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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.metadata" class="fn">metadata</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><InvertedIndexMetas>>> + <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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.fst" class="fn">fst</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="type" href="../../type.FstMap.html" title="type index::inverted_index::FstMap">FstMap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait</span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.fst_vec" class="fn">fst_vec</a><'a, 'life0, 'life1, 'async_trait>(
|
|
&'life0 mut self,
|
|
ranges: &'life1 [<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>],
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="type" href="../../type.FstMap.html" title="type index::inverted_index::FstMap">FstMap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait</span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.bitmap" class="fn">bitmap</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
bitmap_type: <a class="enum" href="../../../bitmap/enum.BitmapType.html" title="enum index::bitmap::BitmapType">BitmapType</a>,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="enum" href="../../../bitmap/enum.Bitmap.html" title="enum index::bitmap::Bitmap">Bitmap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait</span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.bitmap_deque" class="fn">bitmap_deque</a><'a, 'life0, 'life1, 'async_trait>(
|
|
&'life0 mut self,
|
|
ranges: &'life1 [(<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>, <a class="enum" href="../../../bitmap/enum.BitmapType.html" title="enum index::bitmap::BitmapType">BitmapType</a>)],
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/vec_deque/struct.VecDeque.html" title="struct alloc::collections::vec_deque::VecDeque">VecDeque</a><<a class="enum" href="../../../bitmap/enum.Bitmap.html" title="enum index::bitmap::Bitmap">Bitmap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait</span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>InvertedIndexReader defines an asynchronous reader of inverted index data</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.range_read" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#104-109">Source</a><h4 class="code-header">fn <a href="#tymethod.range_read" class="fn">range_read</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Seeks to given offset and reads data with exact size as provided.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read_vec" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#112-116">Source</a><h4 class="code-header">fn <a href="#tymethod.read_vec" class="fn">read_vec</a><'a, 'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
ranges: &'life1 [<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>],
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><Bytes>>> + <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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Reads the bytes in the given ranges.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.metadata" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#119-122">Source</a><h4 class="code-header">fn <a href="#tymethod.metadata" class="fn">metadata</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><InvertedIndexMetas>>> + <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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Retrieves metadata of all inverted indices stored within the blob.</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.fst" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#125-133">Source</a><h4 class="code-header">fn <a href="#method.fst" class="fn">fst</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="type" href="../../type.FstMap.html" title="type index::inverted_index::FstMap">FstMap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Retrieves the finite state transducer (FST) map from the given offset and size.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.fst_vec" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#136-146">Source</a><h4 class="code-header">fn <a href="#method.fst_vec" class="fn">fst_vec</a><'a, 'life0, 'life1, 'async_trait>(
|
|
&'life0 mut self,
|
|
ranges: &'life1 [<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>],
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="type" href="../../type.FstMap.html" title="type index::inverted_index::FstMap">FstMap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Retrieves the multiple finite state transducer (FST) maps from the given ranges.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bitmap" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#149-161">Source</a><h4 class="code-header">fn <a href="#method.bitmap" class="fn">bitmap</a><'a, 'life0, 'async_trait>(
|
|
&'life0 self,
|
|
offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|
size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
bitmap_type: <a class="enum" href="../../../bitmap/enum.BitmapType.html" title="enum index::bitmap::BitmapType">BitmapType</a>,
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="enum" href="../../../bitmap/enum.Bitmap.html" title="enum index::bitmap::Bitmap">Bitmap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Retrieves the bitmap from the given offset and size.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bitmap_deque" class="method"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#164-178">Source</a><h4 class="code-header">fn <a href="#method.bitmap_deque" class="fn">bitmap_deque</a><'a, 'life0, 'life1, 'async_trait>(
|
|
&'life0 mut self,
|
|
ranges: &'life1 [(<a class="struct" href="https://doc.rust-lang.org/nightly/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>>, <a class="enum" href="../../../bitmap/enum.BitmapType.html" title="enum index::bitmap::BitmapType">BitmapType</a>)],
|
|
metrics: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="struct" href="struct.InvertedIndexReadMetrics.html" title="struct index::inverted_index::format::reader::InvertedIndexReadMetrics">InvertedIndexReadMetrics</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="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/vec_deque/struct.VecDeque.html" title="struct alloc::collections::vec_deque::VecDeque">VecDeque</a><<a class="enum" href="../../../bitmap/enum.Bitmap.html" title="enum index::bitmap::Bitmap">Bitmap</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,
|
|
'a: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Retrieves the multiple bitmaps from the given ranges.</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-InvertedIndexReader-for-MockInvertedIndexReader" class="impl"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader.rs.html#100">Source</a><a href="#impl-InvertedIndexReader-for-MockInvertedIndexReader" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.InvertedIndexReader.html" title="trait index::inverted_index::format::reader::InvertedIndexReader">InvertedIndexReader</a> for <a class="struct" href="struct.MockInvertedIndexReader.html" title="struct index::inverted_index::format::reader::MockInvertedIndexReader">MockInvertedIndexReader</a></h3><div class="docblock"><p>InvertedIndexReader defines an asynchronous reader of inverted index data</p>
|
|
</div></section><section id="impl-InvertedIndexReader-for-InvertedIndexBlobReader%3CR%3E" class="impl"><a class="src rightside" href="../../../../src/index/inverted_index/format/reader/blob.rs.html#56-110">Source</a><a href="#impl-InvertedIndexReader-for-InvertedIndexBlobReader%3CR%3E" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="../../../../common_base/range_read/trait.RangeReader.html" title="trait common_base::range_read::RangeReader">RangeReader</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="trait.InvertedIndexReader.html" title="trait index::inverted_index::format::reader::InvertedIndexReader">InvertedIndexReader</a> for <a class="struct" href="struct.InvertedIndexBlobReader.html" title="struct index::inverted_index::format::reader::InvertedIndexBlobReader">InvertedIndexBlobReader</a><R></h3></section></div><script src="../../../../trait.impl/index/inverted_index/format/reader/trait.InvertedIndexReader.js" async></script></section></div></main></body></html> |