mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-17 10:42:55 +00:00
25 lines
9.7 KiB
HTML
25 lines
9.7 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="`AsyncReader` defines an asynchronous reader for puffin data."><title>AsyncReader in puffin::file_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="puffin" 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="#">AsyncReader</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../puffin/index.html">puffin</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Async<wbr>Reader</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Reader" title="Reader">Reader</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.blob_reader" title="blob_reader">blob_reader</a></li><li><a href="#tymethod.metadata" title="metadata">metadata</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In puffin::<wbr>file_<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">puffin</a>::<wbr><a href="../index.html">file_format</a>::<wbr><a href="index.html">reader</a></div><h1>Trait <span class="trait">Async<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/puffin/file_format/reader.rs.html#29-39">Source</a> </span></div><pre class="rust item-decl"><code>pub trait AsyncReader<'a> {
|
|
type <a href="#associatedtype.Reader" class="associatedtype">Reader</a>: RangeReader;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.metadata" class="fn">metadata</a><'async_trait>(
|
|
&'a mut self,
|
|
) -> <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 puffin::error::Result">Result</a><<a class="struct" href="../../file_metadata/struct.FileMetadata.html" title="struct puffin::file_metadata::FileMetadata">FileMetadata</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</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.blob_reader" class="fn">blob_reader</a>(
|
|
&'a mut self,
|
|
blob_metadata: &<a class="struct" href="../../blob_metadata/struct.BlobMetadata.html" title="struct puffin::blob_metadata::BlobMetadata">BlobMetadata</a>,
|
|
) -> <a class="type" href="../../error/type.Result.html" title="type puffin::error::Result">Result</a><Self::<a class="associatedtype" href="trait.AsyncReader.html#associatedtype.Reader" title="type puffin::file_format::reader::AsyncReader::Reader">Reader</a>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>AsyncReader</code> defines an asynchronous reader for puffin data.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Reader" class="method"><a class="src rightside" href="../../../src/puffin/file_format/reader.rs.html#30">Source</a><h4 class="code-header">type <a href="#associatedtype.Reader" class="associatedtype">Reader</a>: RangeReader</h4></section></div><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.metadata" class="method"><a class="src rightside" href="../../../src/puffin/file_format/reader.rs.html#33">Source</a><h4 class="code-header">fn <a href="#tymethod.metadata" class="fn">metadata</a><'async_trait>(
|
|
&'a mut self,
|
|
) -> <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 puffin::error::Result">Result</a><<a class="struct" href="../../file_metadata/struct.FileMetadata.html" title="struct puffin::file_metadata::FileMetadata">FileMetadata</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,</div></h4></section></summary><div class="docblock"><p>Fetches the FileMetadata.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.blob_reader" class="method"><a class="src rightside" href="../../../src/puffin/file_format/reader.rs.html#38">Source</a><h4 class="code-header">fn <a href="#tymethod.blob_reader" class="fn">blob_reader</a>(
|
|
&'a mut self,
|
|
blob_metadata: &<a class="struct" href="../../blob_metadata/struct.BlobMetadata.html" title="struct puffin::blob_metadata::BlobMetadata">BlobMetadata</a>,
|
|
) -> <a class="type" href="../../error/type.Result.html" title="type puffin::error::Result">Result</a><Self::<a class="associatedtype" href="trait.AsyncReader.html#associatedtype.Reader" title="type puffin::file_format::reader::AsyncReader::Reader">Reader</a>></h4></section></summary><div class="docblock"><p>Reads particular blob data based on given metadata.</p>
|
|
<p>Data read from the reader is compressed leaving the caller to decompress the data.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-AsyncReader%3C'a%3E-for-PuffinFileReader%3CR%3E" class="impl"><a class="src rightside" href="../../../src/puffin/file_format/reader/file.rs.html#76-98">Source</a><a href="#impl-AsyncReader%3C'a%3E-for-PuffinFileReader%3CR%3E" class="anchor">§</a><h3 class="code-header">impl<'a, R: RangeReader + 'a> <a class="trait" href="trait.AsyncReader.html" title="trait puffin::file_format::reader::AsyncReader">AsyncReader</a><'a> for <a class="struct" href="struct.PuffinFileReader.html" title="struct puffin::file_format::reader::PuffinFileReader">PuffinFileReader</a><R></h3></section></summary><div class="impl-items"><section id="associatedtype.Reader-1" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/puffin/file_format/reader/file.rs.html#77">Source</a><a href="#associatedtype.Reader-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Reader" class="associatedtype">Reader</a> = <a class="struct" href="../../partial_reader/struct.PartialReader.html" title="struct puffin::partial_reader::PartialReader">PartialReader</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a R</a>></h4></section></div></details></div><script src="../../../trait.impl/puffin/file_format/reader/trait.AsyncReader.js" async></script></section></div></main></body></html> |