Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -0,0 +1,38 @@
|
||||
<!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="Enter an element into the plugin registry corresponding to its type."><meta name="keywords" content="rust, rustlang, rust-lang, submit"><title>inventory::submit - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../inventory/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="index.html">inventory</a></p><div id="sidebar-vars" data-name="submit" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">inventory</a>::<wbr><a class="macro" href="">submit</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/inventory/lib.rs.html#370-376" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
||||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">submit</span> {
|
||||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">value</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||||
}</pre></div>
|
||||
</div><div class="docblock"><p>Enter an element into the plugin registry corresponding to its type.</p>
|
||||
<p>This call may be in the same crate that defines the type, or downstream in
|
||||
any crate that depends on that crate.</p>
|
||||
<p>This macro does not “run” anything so place it outside of any function body.
|
||||
In particular, note that all <code>submit!</code> invocations across all source files
|
||||
linked into your application all take effect simultaneously. A <code>submit!</code>
|
||||
invocation is not a statement that needs to be called from <code>main</code> in order
|
||||
to execute.</p>
|
||||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||||
<p>Put <code>submit!</code> invocations outside of any function body.</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="ident">inventory</span>::<span class="macro">submit</span><span class="macro">!</span> {
|
||||
<span class="ident">Flag</span>::<span class="ident">new</span>(<span class="string">'v'</span>, <span class="string">"verbose"</span>)
|
||||
}</pre></div>
|
||||
<p>Do not try to invoke <code>submit!</code> from inside of a function body as it does not
|
||||
do what you want.</p>
|
||||
|
||||
<div class='information'><div class='tooltip compile_fail'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered compile_fail">
|
||||
<span class="comment">// Do not do this.</span>
|
||||
<span class="kw">fn</span> <span class="ident">submit_flags</span>(<span class="ident">has_verbose_flag</span>: <span class="ident">bool</span>) {
|
||||
<span class="kw">if</span> <span class="ident">has_verbose_flag</span> {
|
||||
<span class="ident">inventory</span>::<span class="macro">submit</span><span class="macro">!</span> {
|
||||
<span class="ident">Flag</span>::<span class="ident">new</span>(<span class="string">'v'</span>, <span class="string">"verbose"</span>)
|
||||
}
|
||||
}
|
||||
}</pre></div>
|
||||
<p>Refer to the <a href="index.html">crate level documentation</a> for a complete example
|
||||
of instantiating and iterating a plugin registry.</p>
|
||||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="inventory" data-search-js="../search-index.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
Reference in New Issue
Block a user