Files

6 lines
5.6 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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 `substrait` crate."><title>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-1ed95124.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.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../static.files/storage-41dd4d93.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-417ebf0a.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 mod crate"><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="#">Crate substrait</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../substrait/index.html">substrait</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>substrait</span>&nbsp;<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#15-46">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.substrait_proto_df"><code>pub use datafusion_substrait::substrait as substrait_proto_df;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="df_logical_plan/index.html" title="mod substrait::df_logical_plan">df_<wbr>logical_<wbr>plan</a></dt><dt><a class="mod" href="df_substrait/index.html" title="mod substrait::df_substrait">df_<wbr>substrait</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="error/index.html" title="mod substrait::error">error</a></dt><dt><a class="mod" href="extension_serializer/index.html" title="mod substrait::extension_serializer">extension_<wbr>serializer</a></dt><dt><a class="mod" href="variation_const/index.html" title="mod substrait::variation_const">variation_<wbr>const</a></dt><dd>Type variation constants</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.DFLogicalSubstraitConvertor.html" title="struct substrait::DFLogicalSubstraitConvertor">DFLogical<wbr>Substrait<wbr>Convertor</a></dt><dt><a class="struct" href="struct.Extensions.html" title="struct substrait::Extensions">Extensions</a></dt><dd>Substrait uses <a href="https://substrait.io/extensions/#simple-extensions">SimpleExtensions</a> to define
behavior of plans in addition to what’s supported directly by the protobuf definitions.
That includes functions, but also provides support for custom types and variations for existing
types. This structs facilitates the use of these extensions in DataFusion.
TODO: DF doesn’t yet use extensions for type variations <a href="https://github.com/apache/datafusion/issues/11544">https://github.com/apache/datafusion/issues/11544</a>
TODO: DF doesn’t yet provide valid extensionUris <a href="https://github.com/apache/datafusion/issues/11545">https://github.com/apache/datafusion/issues/11545</a></dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.SerializerRegistry.html" title="trait substrait::SerializerRegistry">Serializer<wbr>Registry</a></dt><dd>Serializer and deserializer registry for extensions like [UserDefinedLogicalNode].</dd><dt><a class="trait" href="trait.SubstraitPlan.html" title="trait substrait::SubstraitPlan">Substrait<wbr>Plan</a></dt></dl></section></div></main></body></html>