mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-13 00:32:56 +00:00
7 lines
7.5 KiB
HTML
7 lines
7.5 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="This module contains the definition of functions that can be used in expressions."><title>flow::expr::func - 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="flow" 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 mod"><!--[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="#">Module func</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../flow/index.html">flow</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="#">Module func</a></h2><h3><a href="#macros">Module Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In flow::<wbr>expr</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">flow</a>::<wbr><a href="../index.html">expr</a></div><h1>Module <span>func</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/flow/expr/func.rs.html#15-1467">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module contains the definition of functions that can be used in expressions.</p>
|
||
</div></details><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.generate_binary_signature.html" title="macro flow::expr::func::generate_binary_signature">generate_<wbr>binary_<wbr>signature</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Generate binary function signature based on the function and the input types
|
||
The user can provide custom signature for some functions in the form of a regular match arm,
|
||
and the rest will be generated according to the provided list of functions like this:</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.BinaryFuncIter.html" title="struct flow::expr::func::BinaryFuncIter">Binary<wbr>Func<wbr>Iter</a></dt><dd>An iterator over the variants of <a href="enum.BinaryFunc.html" title="enum flow::expr::func::BinaryFunc">BinaryFunc</a></dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.BinaryFunc.html" title="enum flow::expr::func::BinaryFunc">Binary<wbr>Func</a></dt><dd>BinaryFunc is a function that takes two arguments.
|
||
Also notice this enum doesn’t contain function arguments, since the arguments are stored in the expression.</dd><dt><a class="enum" href="enum.UnaryFunc.html" title="enum flow::expr::func::UnaryFunc">Unary<wbr>Func</a></dt><dd>UnaryFunc is a function that takes one argument. Also notice this enum doesn’t contain function arguments,
|
||
because the arguments are stored in the expression. (except <code>cast</code> function, which requires a type argument)</dd><dt><a class="enum" href="enum.UnmaterializableFunc.html" title="enum flow::expr::func::UnmaterializableFunc">Unmaterializable<wbr>Func</a></dt><dd>UnmaterializableFunc is a function that can’t be eval independently,
|
||
and require special handling</dd><dt><a class="enum" href="enum.VariadicFunc.html" title="enum flow::expr::func::VariadicFunc">Variadic<wbr>Func</a></dt><dd>VariadicFunc is a function that takes a variable number of arguments.</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.SPECIALIZATION.html" title="static flow::expr::func::SPECIALIZATION">SPECIALIZATION</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.add.html" title="fn flow::expr::func::add">add</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.and.html" title="fn flow::expr::func::and">and</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.div.html" title="fn flow::expr::func::div">div</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.get_timestamp_array.html" title="fn flow::expr::func::get_timestamp_array">get_<wbr>timestamp_<wbr>array</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.get_ts_as_millisecond.html" title="fn flow::expr::func::get_ts_as_millisecond">get_<wbr>ts_<wbr>as_<wbr>millisecond</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.get_window_start.html" title="fn flow::expr::func::get_window_start">get_<wbr>window_<wbr>start</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.mul.html" title="fn flow::expr::func::mul">mul</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.or.html" title="fn flow::expr::func::or">or</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.rem.html" title="fn flow::expr::func::rem">rem</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.sub.html" title="fn flow::expr::func::sub">sub</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |