mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-14 12:00:40 +00:00
9 lines
12 KiB
HTML
9 lines
12 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 `RecordBatchStream` trait in crate `common_recordbatch`."><title>RecordBatchStream in common_recordbatch - 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="common_recordbatch" 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="#">RecordBatchStream</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_recordbatch/index.html">common_<wbr>recordbatch</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Record<wbr>Batch<wbr>Stream</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.metrics" title="metrics">metrics</a></li><li><a href="#tymethod.output_ordering" title="output_ordering">output_ordering</a></li><li><a href="#tymethod.schema" title="schema">schema</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.name" title="name">name</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate common_<wbr>recordbatch</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">common_recordbatch</a></div><h1>Trait <span class="trait">Record<wbr>Batch<wbr>Stream</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_recordbatch/lib.rs.html#53-63">Source</a> </span></div><pre class="rust item-decl"><code>pub trait RecordBatchStream: Stream<Item = <a class="type" href="error/type.Result.html" title="type common_recordbatch::error::Result">Result</a><<a class="struct" href="recordbatch/struct.RecordBatch.html" title="struct common_recordbatch::recordbatch::RecordBatch">RecordBatch</a>>> {
|
|
// Required methods
|
|
fn <a href="#tymethod.schema" class="fn">schema</a>(&self) -> SchemaRef;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.output_ordering" class="fn">output_ordering</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="struct" href="struct.OrderOption.html" title="struct common_recordbatch::OrderOption">OrderOption</a>]>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.metrics" class="fn">metrics</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="adapter/struct.RecordBatchMetrics.html" title="struct common_recordbatch::adapter::RecordBatchMetrics">RecordBatchMetrics</a>>;
|
|
|
|
// Provided method
|
|
fn <a href="#method.name" class="fn">name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a> { ... }
|
|
}</code></pre><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.schema" class="method"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#58">Source</a><h4 class="code-header">fn <a href="#tymethod.schema" class="fn">schema</a>(&self) -> SchemaRef</h4></section><section id="tymethod.output_ordering" class="method"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#60">Source</a><h4 class="code-header">fn <a href="#tymethod.output_ordering" class="fn">output_ordering</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="struct" href="struct.OrderOption.html" title="struct common_recordbatch::OrderOption">OrderOption</a>]></h4></section><section id="tymethod.metrics" class="method"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#62">Source</a><h4 class="code-header">fn <a href="#tymethod.metrics" class="fn">metrics</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="adapter/struct.RecordBatchMetrics.html" title="struct common_recordbatch::adapter::RecordBatchMetrics">RecordBatchMetrics</a>></h4></section></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><section id="method.name" class="method"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#54-56">Source</a><h4 class="code-header">fn <a href="#method.name" class="fn">name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section></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-RecordBatchStream-for-AsyncRecordBatchStreamAdapter" class="impl"><a class="src rightside" href="../src/common_recordbatch/adapter.rs.html#549-561">Source</a><a href="#impl-RecordBatchStream-for-AsyncRecordBatchStreamAdapter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="adapter/struct.AsyncRecordBatchStreamAdapter.html" title="struct common_recordbatch::adapter::AsyncRecordBatchStreamAdapter">AsyncRecordBatchStreamAdapter</a></h3></section><section id="impl-RecordBatchStream-for-RecordBatchStreamAdapter" class="impl"><a class="src rightside" href="../src/common_recordbatch/adapter.rs.html#271-292">Source</a><a href="#impl-RecordBatchStream-for-RecordBatchStreamAdapter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="adapter/struct.RecordBatchStreamAdapter.html" title="struct common_recordbatch::adapter::RecordBatchStreamAdapter">RecordBatchStreamAdapter</a></h3></section><section id="impl-RecordBatchStream-for-EmptyRecordBatchStream" class="impl"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#231-243">Source</a><a href="#impl-RecordBatchStream-for-EmptyRecordBatchStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="struct.EmptyRecordBatchStream.html" title="struct common_recordbatch::EmptyRecordBatchStream">EmptyRecordBatchStream</a></h3></section><section id="impl-RecordBatchStream-for-MemoryTrackedStream" class="impl"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#816-828">Source</a><a href="#impl-RecordBatchStream-for-MemoryTrackedStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="struct.MemoryTrackedStream.html" title="struct common_recordbatch::MemoryTrackedStream">MemoryTrackedStream</a></h3></section><section id="impl-RecordBatchStream-for-SendableRecordBatchMapper" class="impl"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#182-198">Source</a><a href="#impl-RecordBatchStream-for-SendableRecordBatchMapper" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="struct.SendableRecordBatchMapper.html" title="struct common_recordbatch::SendableRecordBatchMapper">SendableRecordBatchMapper</a></h3></section><section id="impl-RecordBatchStream-for-SimpleRecordBatchStream" class="impl"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#344-356">Source</a><a href="#impl-RecordBatchStream-for-SimpleRecordBatchStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="struct.SimpleRecordBatchStream.html" title="struct common_recordbatch::SimpleRecordBatchStream">SimpleRecordBatchStream</a></h3></section><section id="impl-RecordBatchStream-for-ChainedRecordBatchStream" class="impl"><a class="src rightside" href="../src/common_recordbatch/util.rs.html#101-117">Source</a><a href="#impl-RecordBatchStream-for-ChainedRecordBatchStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="util/struct.ChainedRecordBatchStream.html" title="struct common_recordbatch::util::ChainedRecordBatchStream">ChainedRecordBatchStream</a></h3></section><section id="impl-RecordBatchStream-for-RecordBatchStreamWrapper%3CS%3E" class="impl"><a class="src rightside" href="../src/common_recordbatch/lib.rs.html#394-412">Source</a><a href="#impl-RecordBatchStream-for-RecordBatchStreamWrapper%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S: Stream<Item = <a class="type" href="error/type.Result.html" title="type common_recordbatch::error::Result">Result</a><<a class="struct" href="recordbatch/struct.RecordBatch.html" title="struct common_recordbatch::recordbatch::RecordBatch">RecordBatch</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.RecordBatchStream.html" title="trait common_recordbatch::RecordBatchStream">RecordBatchStream</a> for <a class="struct" href="struct.RecordBatchStreamWrapper.html" title="struct common_recordbatch::RecordBatchStreamWrapper">RecordBatchStreamWrapper</a><S></h3></section></div><script src="../trait.impl/common_recordbatch/trait.RecordBatchStream.js" async></script></section></div></main></body></html> |