34 lines
7.7 KiB
HTML
34 lines
7.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="Creates a [`SmallVec`] containing the arguments."><meta name="keywords" content="rust, rustlang, rust-lang, smallvec"><title>smallvec in smallvec - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></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 class="sidebar-logo" href="../smallvec/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">smallvec</a></h2><div id="sidebar-vars" data-name="smallvec" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../smallvec/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">smallvec</a>::<wbr><a class="macro" href="#">smallvec</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></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/smallvec/lib.rs.html#163-180" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">smallvec</span> {
|
||
(@ <span class="ident">one</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">x</span> : <span class="ident">expr</span>) => { ... };
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">elem</span> : <span class="ident">expr</span> ; <span class="macro-nonterminal">$</span><span class="macro-nonterminal">n</span> : <span class="ident">expr</span>) => { ... };
|
||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">x</span> : <span class="ident">expr</span>), <span class="op">*</span> $(,) <span class="kw-2">*</span>) => { ... };
|
||
}</code></pre></div>
|
||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a <a href="struct.SmallVec.html" title="SmallVec"><code>SmallVec</code></a> containing the arguments.</p>
|
||
<p><code>smallvec!</code> allows <code>SmallVec</code>s to be defined with the same syntax as array expressions.
|
||
There are two forms of this macro:</p>
|
||
<ul>
|
||
<li>Create a <a href="struct.SmallVec.html" title="SmallVec"><code>SmallVec</code></a> containing a given list of elements:</li>
|
||
</ul>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">v</span>: <span class="ident">SmallVec</span><span class="op"><</span>[<span class="kw">_</span>; <span class="number">128</span>]<span class="op">></span> <span class="op">=</span> <span class="macro">smallvec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
||
<span class="macro">assert_eq!</span>(<span class="ident">v</span>[<span class="number">0</span>], <span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">v</span>[<span class="number">1</span>], <span class="number">2</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">v</span>[<span class="number">2</span>], <span class="number">3</span>);</code></pre></div>
|
||
<ul>
|
||
<li>Create a <a href="struct.SmallVec.html" title="SmallVec"><code>SmallVec</code></a> from a given element and size:</li>
|
||
</ul>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">v</span>: <span class="ident">SmallVec</span><span class="op"><</span>[<span class="kw">_</span>; <span class="number">0x8000</span>]<span class="op">></span> <span class="op">=</span> <span class="macro">smallvec!</span>[<span class="number">1</span>; <span class="number">3</span>];
|
||
<span class="macro">assert_eq!</span>(<span class="ident">v</span>, <span class="ident">SmallVec::from_buf</span>([<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>]));</code></pre></div>
|
||
<p>Note that unlike array expressions this syntax supports all elements
|
||
which implement <a href="https://doc.rust-lang.org/1.59.0/core/clone/trait.Clone.html" title="Clone"><code>Clone</code></a> and the number of elements doesn’t have to be
|
||
a constant.</p>
|
||
<p>This will use <code>clone</code> to duplicate an expression, so one should be careful
|
||
using this with types having a nonstandard <code>Clone</code> implementation. For
|
||
example, <code>smallvec![Rc::new(1); 5]</code> will create a vector of five references
|
||
to the same boxed integer value, not five references pointing to independently
|
||
boxed integers.</p>
|
||
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="smallvec" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |