mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-22 22:20:02 +00:00
13 lines
11 KiB
HTML
13 lines
11 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="API documentation for the Rust `ArrowDecoder` trait in crate `common_datasource`."><title>ArrowDecoder in common_datasource::file_format - 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="common_datasource" 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="#">ArrowDecoder</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_datasource/index.html">common_<wbr>datasource</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="#">Arrow<wbr>Decoder</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.decode" title="decode">decode</a></li><li><a href="#tymethod.flush" title="flush">flush</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ArrowDecoder-for-Decoder" title="Decoder">Decoder</a></li><li><a href="#impl-ArrowDecoder-for-Decoder" title="Decoder">Decoder</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In common_<wbr>datasource::<wbr>file_<wbr>format</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">common_datasource</a>::<wbr><a href="index.html">file_format</a></div><h1>Trait <span class="trait">Arrow<wbr>Decoder</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/common_datasource/file_format.rs.html#115-131">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ArrowDecoder: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static {
|
|
// Required methods
|
|
fn <a href="#tymethod.decode" class="fn">decode</a>(&mut self, buf: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, ArrowError>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.flush" class="fn">flush</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><RecordBatch>, ArrowError>;
|
|
}</code></pre><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.decode" class="method"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#122">Source</a><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a>(&mut self, buf: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, ArrowError></h4></section></summary><div class="docblock"><p>Decode records from <code>buf</code> returning the number of bytes read.</p>
|
|
<p>This method returns <code>Ok(0)</code> once <code>batch_size</code> objects have been parsed since the
|
|
last call to <a href="trait.ArrowDecoder.html#tymethod.flush"><code>Self::flush</code></a>, or <code>buf</code> is exhausted.</p>
|
|
<p>Any remaining bytes should be included in the next call to <a href="trait.ArrowDecoder.html#tymethod.decode"><code>Self::decode</code></a>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.flush" class="method"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#130">Source</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><RecordBatch>, ArrowError></h4></section></summary><div class="docblock"><p>Flushes the currently buffered data to a [<code>RecordBatch</code>].</p>
|
|
<p>This should only be called after <a href="trait.ArrowDecoder.html#tymethod.decode"><code>Self::decode</code></a> has returned <code>Ok(0)</code>,
|
|
otherwise may return an error if part way through decoding a record</p>
|
|
<p>Returns <code>Ok(None)</code> if no buffered data.</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ArrowDecoder-for-Decoder" class="impl"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#133-141">Source</a><a href="#impl-ArrowDecoder-for-Decoder" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ArrowDecoder.html" title="trait common_datasource::file_format::ArrowDecoder">ArrowDecoder</a> for Decoder</h3></section></summary><div class="impl-items"><section id="method.decode" class="method trait-impl"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#134-136">Source</a><a href="#method.decode" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a>(&mut self, buf: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, ArrowError></h4></section><section id="method.flush" class="method trait-impl"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#138-140">Source</a><a href="#method.flush" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><RecordBatch>, ArrowError></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ArrowDecoder-for-Decoder-1" class="impl"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#143-151">Source</a><a href="#impl-ArrowDecoder-for-Decoder-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ArrowDecoder.html" title="trait common_datasource::file_format::ArrowDecoder">ArrowDecoder</a> for Decoder</h3></section></summary><div class="impl-items"><section id="method.decode-1" class="method trait-impl"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#144-146">Source</a><a href="#method.decode-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a>(&mut self, buf: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, ArrowError></h4></section><section id="method.flush-1" class="method trait-impl"><a class="src rightside" href="../../src/common_datasource/file_format.rs.html#148-150">Source</a><a href="#method.flush-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><RecordBatch>, ArrowError></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/common_datasource/file_format/trait.ArrowDecoder.js" data-ignore-extern-crates="arrow_csv,arrow_json" async></script></section></div></main></body></html> |