Files
GopherGate/target/doc/smallvec/macro.smallvec.html
2026-02-26 12:00:21 -05:00

31 lines
5.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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."><title>smallvec in smallvec - 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-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="smallvec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.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 macro"><!--[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="#">smallvec</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../smallvec/index.html">smallvec</a><span class="version">1.15.1</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">smallvec</a></div><h1>Macro <span class="macro">smallvec</span>&nbsp;<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/smallvec/lib.rs.html#184-203">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! smallvec {
(@one $x:expr) =&gt; { ... };
() =&gt; { ... };
($elem:expr; $n:expr) =&gt; { ... };
($($x:expr),+$(,)?) =&gt; { ... };
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a <a href="struct.SmallVec.html" title="struct smallvec::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="struct smallvec::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>v: SmallVec&lt;[<span class="kw">_</span>; <span class="number">128</span>]&gt; = <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>(v[<span class="number">0</span>], <span class="number">1</span>);
<span class="macro">assert_eq!</span>(v[<span class="number">1</span>], <span class="number">2</span>);
<span class="macro">assert_eq!</span>(v[<span class="number">2</span>], <span class="number">3</span>);</code></pre></div>
<ul>
<li>Create a <a href="struct.SmallVec.html" title="struct smallvec::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>v: SmallVec&lt;[<span class="kw">_</span>; <span class="number">0x8000</span>]&gt; = <span class="macro">smallvec!</span>[<span class="number">1</span>; <span class="number">3</span>];
<span class="macro">assert_eq!</span>(v, SmallVec::from_buf([<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.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone"><code>Clone</code></a> and the number of elements doesnt 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></div></main></body></html>