mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-23 06:30:05 +00:00
6 lines
7.0 KiB
HTML
6 lines
7.0 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 `common_macro` crate."><title>common_macro - 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_macro" 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="../crates.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 crate"><!--[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 common_macro</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_macro/index.html">common_<wbr>macro</a><span class="version">1.0.0-beta.3</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="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#attributes" title="Attribute Macros">Attribute Macros</a></li><li><a href="#derives" title="Derive Macros">Derive Macros</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"><div class="main-heading"><h1>Crate <span>common_<wbr>macro</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_macro/lib.rs.html#15-306">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="admin_fn/index.html" title="mod common_macro::admin_fn">admin_<wbr>fn</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="aggr_func/index.html" title="mod common_macro::aggr_func">aggr_<wbr>func</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="print_caller/index.html" title="mod common_macro::print_caller">print_<wbr>caller</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="range_fn/index.html" title="mod common_macro::range_fn">range_<wbr>fn</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="row/index.html" title="mod common_macro::row">row</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="stack_trace_debug/index.html" title="mod common_macro::stack_trace_debug">stack_<wbr>trace_<wbr>debug</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>implement <code>::common_error::ext::StackError</code></dd><dt><a class="mod" href="utils/index.html" title="mod common_macro::utils">utils</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="attributes" class="section-header">Attribute Macros<a href="#attributes" class="anchor">§</a></h2><dl class="item-table"><dt><a class="attr" href="attr.admin_fn.html" title="attr common_macro::admin_fn">admin_<wbr>fn</a></dt><dd>Attribute macro to convert a normal function to SQL administration function. The annotated function
|
|
should accept:</dd><dt><a class="attr" href="attr.as_aggr_func_creator.html" title="attr common_macro::as_aggr_func_creator">as_<wbr>aggr_<wbr>func_<wbr>creator</a></dt><dd>A struct can be used as a creator for aggregate function if it has been annotated with this
|
|
attribute first.</dd><dt><a class="attr" href="attr.print_caller.html" title="attr common_macro::print_caller">print_<wbr>caller</a></dt><dd>Attribute macro to print the caller to the annotated function.
|
|
The caller is printed as its filename and the call site line number.</dd><dt><a class="attr" href="attr.range_fn.html" title="attr common_macro::range_fn">range_<wbr>fn</a></dt><dd>Attribute macro to convert an arithimetic function to a range function. The annotated function
|
|
should accept servaral arrays as input and return a single value as output.</dd><dt><a class="attr" href="attr.stack_trace_debug.html" title="attr common_macro::stack_trace_debug">stack_<wbr>trace_<wbr>debug</a></dt><dd>Attribute macro to derive <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">std::fmt::Debug</a> for the annotated <code>Error</code> type.</dd></dl><h2 id="derives" class="section-header">Derive Macros<a href="#derives" class="anchor">§</a></h2><dl class="item-table"><dt><a class="derive" href="derive.AggrFuncTypeStore.html" title="derive common_macro::AggrFuncTypeStore">Aggr<wbr>Func<wbr>Type<wbr>Store</a></dt><dd>Make struct implemented trait <a href="derive.AggrFuncTypeStore.html" title="derive common_macro::AggrFuncTypeStore">AggrFuncTypeStore</a>, which is necessary when writing UDAF.
|
|
This derive macro is expect to be used along with attribute macro <a href="attr.as_aggr_func_creator.html" title="attr common_macro::as_aggr_func_creator">as_aggr_func_creator</a>.</dd><dt><a class="derive" href="derive.IntoRow.html" title="derive common_macro::IntoRow">IntoRow</a></dt><dd>Derive macro to convert a struct to a row with move semantics.</dd><dt><a class="derive" href="derive.Schema.html" title="derive common_macro::Schema">Schema</a></dt><dd>Derive macro to convert a struct to a schema.</dd><dt><a class="derive" href="derive.ToMetaBuilder.html" title="derive common_macro::ToMetaBuilder">ToMeta<wbr>Builder</a></dt><dd>Generates implementation for <code>From<&TableMeta> for TableMetaBuilder</code></dd><dt><a class="derive" href="derive.ToRow.html" title="derive common_macro::ToRow">ToRow</a></dt><dd>Derive macro to convert a struct to a row.</dd></dl></section></div></main></body></html> |