github-actions[bot]
30 lines
5.0 KiB
HTML
30 lines
5.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="Associate a plugin registry with the specified type."><meta name="keywords" content="rust, rustlang, rust-lang, collect"><title>collect in inventory - 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 11]><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="collect" 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><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="">collect</a><button id="copy-path" onclick="copy_path(this)">⎘</button></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#308-318" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><div class="example-wrap"><pre class="rust macro">
|
||
<span class="macro">macro_rules!</span> <span class="ident">collect</span> {
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">ty</span>:<span class="ident">ty</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
}</pre></div>
|
||
</div><div class="docblock"><p>Associate a plugin registry with the specified type.</p>
|
||
<p>This call must be in the same crate that defines the plugin type. This macro
|
||
does not “run” anything so place it outside of any function body.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Suppose we are writing a command line flags library and want to allow any
|
||
source file in the application to register command line flags that are
|
||
relevant to it.</p>
|
||
<p>This is the flag registration style used by <a href="https://gflags.github.io/gflags/">gflags</a> and is better suited
|
||
for large scale development than maintaining a single central list of flags,
|
||
as the central list would become an endless source of merge conflicts.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Flag</span> {
|
||
<span class="ident">short</span>: <span class="ident">char</span>,
|
||
<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
|
||
<span class="comment">/* ... */</span>
|
||
}
|
||
|
||
<span class="macro">inventory::collect!</span>(<span class="ident">Flag</span>);</pre></div>
|
||
<p>Refer to the <a href="index.html">crate level documentation</a> for a complete example
|
||
of submitting plugins and iterating a plugin registry.</p>
|
||
</div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="inventory" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script></body></html> |