mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-09-13 00:42:14 +00:00
7 lines
6.7 KiB
HTML
7 lines
6.7 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 `plugin_options` mod in crate `common_options`."><title>common_options::plugin_options - 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_options" 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 mod"><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="#">Module plugin_options</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_options/index.html">common_<wbr>options</a><span class="version">1.3.0-alpha.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module plugin_<wbr>options</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate common_<wbr>options</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_options</a></div><h1>Module <span>plugin_<wbr>options</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_options/plugin_options.rs.html#15-306">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.StandaloneFlag.html" title="struct common_options::plugin_options::StandaloneFlag">Standalone<wbr>Flag</a></dt><dd>A flag for stating the standalone mode in the plugins.</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.DROPPED_PLUGIN_TAGS.html" title="static common_options::plugin_options::DROPPED_PLUGIN_TAGS">DROPPED_<wbr>PLUGIN_<wbr>TAGS</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Buffer of plugin option tags that were dropped during config loading because
|
||
they are not recognized by the current build.</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.PluginOptionsDeserializer.html" title="trait common_options::plugin_options::PluginOptionsDeserializer">Plugin<wbr>Options<wbr>Deserializer</a></dt><dd>A trait for deserializing Metasrv config from a JSON string.</dd><dt><a class="trait" href="trait.PluginOptionsSerializer.html" title="trait common_options::plugin_options::PluginOptionsSerializer">Plugin<wbr>Options<wbr>Serializer</a></dt><dd>A trait for serializing Metasrv config to a JSON string.
|
||
So it can be used in the metasrv’s crate instead of depending on the plugins’ crate.</dd></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.collect_from_entry.html" title="fn common_options::plugin_options::collect_from_entry">collect_<wbr>from_<wbr>entry</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Extracts the recognized plugin options from one config entry.</dd><dt><a class="fn" href="fn.filter_known_plugin_options.html" title="fn common_options::plugin_options::filter_known_plugin_options">filter_<wbr>known_<wbr>plugin_<wbr>options</a></dt><dd>Deserializes a list of plugin options leniently.</dd><dt><a class="fn" href="fn.is_unknown_variant_tag.html" title="fn common_options::plugin_options::is_unknown_variant_tag">is_<wbr>unknown_<wbr>variant_<wbr>tag</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Decides whether <code>tag</code> names a variant unknown to <code>T</code>, <em>without</em> <code>T</code> having
|
||
to enumerate its variants.</dd><dt><a class="fn" href="fn.record_dropped_plugin.html" title="fn common_options::plugin_options::record_dropped_plugin">record_<wbr>dropped_<wbr>plugin</a></dt><dd>Records a plugin option tag that was dropped because it is not recognized by
|
||
this build (for example, an enterprise plugin option seen by an open-source
|
||
build).</dd><dt><a class="fn" href="fn.take_dropped_plugin_warnings.html" title="fn common_options::plugin_options::take_dropped_plugin_warnings">take_<wbr>dropped_<wbr>plugin_<wbr>warnings</a></dt><dd>Takes (and clears) the buffered dropped-plugin tags so they can be logged
|
||
after the global logging is up.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.PluginOptionsSerializerRef.html" title="type common_options::plugin_options::PluginOptionsSerializerRef">Plugin<wbr>Options<wbr>Serializer<wbr>Ref</a></dt></dl></section></div></main></body></html> |