mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-02 22:02:14 +00:00
34 lines
6.5 KiB
HTML
34 lines
6.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="API documentation for the Rust `submit` macro in crate `inventory`."><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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><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">☰</div><a href='../inventory/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>inventory</a></p><script>window.sidebarCurrent = {name: 'submit', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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#336-342' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>inventory</a>::<wbr><a class="macro" href=''>submit</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'>ⓘ<span class='tooltiptext'>This example deliberately fails to compile</span></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><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "inventory";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |