mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-10 07:12:54 +00:00
30 lines
11 KiB
HTML
30 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 `SubstraitPlan` trait in crate `substrait`."><title>SubstraitPlan in substrait - 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="substrait" 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="#">SubstraitPlan</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../substrait/index.html">substrait</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="#">Substrait<wbr>Plan</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li><li><a href="#associatedtype.Plan" title="Plan">Plan</a></li></ul><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.encode" title="encode">encode</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate substrait</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">substrait</a></div><h1>Trait <span class="trait">Substrait<wbr>Plan</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/substrait/lib.rs.html#31-47">Source</a> </span></div><pre class="rust item-decl"><code>pub trait SubstraitPlan {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/error/trait.Error.html" title="trait core::error::Error">Error</a>;
|
|
type <a href="#associatedtype.Plan" class="associatedtype">Plan</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.decode" class="fn">decode</a><'life0, 'async_trait, B>(
|
|
&'life0 self,
|
|
message: B,
|
|
state: SessionState,
|
|
) -> <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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Plan" title="type substrait::SubstraitPlan::Plan">Plan</a>, Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Error" title="type substrait::SubstraitPlan::Error">Error</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 B: 'async_trait + Buf + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.encode" class="fn">encode</a>(
|
|
&self,
|
|
plan: &Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Plan" title="type substrait::SubstraitPlan::Plan">Plan</a>,
|
|
serializer: impl <a class="trait" href="trait.SerializerRegistry.html" title="trait substrait::SerializerRegistry">SerializerRegistry</a> + 'static,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Error" title="type substrait::SubstraitPlan::Error">Error</a>>;
|
|
}</code></pre><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.Error" class="method"><a class="src rightside" href="../src/substrait/lib.rs.html#32">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/error/trait.Error.html" title="trait core::error::Error">Error</a></h4></section><section id="associatedtype.Plan" class="method"><a class="src rightside" href="../src/substrait/lib.rs.html#34">Source</a><h4 class="code-header">type <a href="#associatedtype.Plan" class="associatedtype">Plan</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.decode" class="method"><a class="src rightside" href="../src/substrait/lib.rs.html#36-40">Source</a><h4 class="code-header">fn <a href="#tymethod.decode" class="fn">decode</a><'life0, 'async_trait, B>(
|
|
&'life0 self,
|
|
message: B,
|
|
state: SessionState,
|
|
) -> <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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Plan" title="type substrait::SubstraitPlan::Plan">Plan</a>, Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Error" title="type substrait::SubstraitPlan::Error">Error</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
|
|
B: 'async_trait + Buf + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section><section id="tymethod.encode" class="method"><a class="src rightside" href="../src/substrait/lib.rs.html#42-46">Source</a><h4 class="code-header">fn <a href="#tymethod.encode" class="fn">encode</a>(
|
|
&self,
|
|
plan: &Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Plan" title="type substrait::SubstraitPlan::Plan">Plan</a>,
|
|
serializer: impl <a class="trait" href="trait.SerializerRegistry.html" title="trait substrait::SerializerRegistry">SerializerRegistry</a> + 'static,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Bytes, Self::<a class="associatedtype" href="trait.SubstraitPlan.html#associatedtype.Error" title="type substrait::SubstraitPlan::Error">Error</a>></h4></section></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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-SubstraitPlan-for-DFLogicalSubstraitConvertor" class="impl"><a class="src rightside" href="../src/substrait/df_substrait.rs.html#40-74">Source</a><a href="#impl-SubstraitPlan-for-DFLogicalSubstraitConvertor" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SubstraitPlan.html" title="trait substrait::SubstraitPlan">SubstraitPlan</a> for <a class="struct" href="struct.DFLogicalSubstraitConvertor.html" title="struct substrait::DFLogicalSubstraitConvertor">DFLogicalSubstraitConvertor</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/substrait/df_substrait.rs.html#41">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="error/enum.Error.html" title="enum substrait::error::Error">Error</a></h4></section><section id="associatedtype.Plan-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/substrait/df_substrait.rs.html#43">Source</a><a href="#associatedtype.Plan-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Plan" class="associatedtype">Plan</a> = LogicalPlan</h4></section></div></details></div><script src="../trait.impl/substrait/trait.SubstraitPlan.js" async></script></section></div></main></body></html> |