26 lines
8.1 KiB
HTML
26 lines
8.1 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="Helper to make a `TinyVec`."><meta name="keywords" content="rust, rustlang, rust-lang, tiny_vec"><title>tiny_vec in tinyvec - 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="../tinyvec/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">tinyvec</a></h2><div id="sidebar-vars" data-name="tiny_vec" 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="../tinyvec/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">tinyvec</a>::<wbr><a class="macro" href="#">tiny_vec</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/tinyvec/tinyvec.rs.html#36-65" 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">tiny_vec</span> {
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">array_type</span> : <span class="ident">ty</span> => $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">elem</span> : <span class="ident">expr</span>), <span class="op">*</span> $(,) <span class="question-mark">?</span>) => { ... };
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">array_type</span> : <span class="ident">ty</span>) => { ... };
|
||
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">elem</span> : <span class="ident">expr</span>), <span class="kw-2">*</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>) => { ... };
|
||
() => { ... };
|
||
}</code></pre></div>
|
||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper to make a <code>TinyVec</code>.</p>
|
||
<p>You specify the backing array type, and optionally give all the elements you
|
||
want to initially place into the array.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tinyvec</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="comment">// The backing array type can be specified in the macro call</span>
|
||
<span class="kw">let</span> <span class="ident">empty_tv</span> <span class="op">=</span> <span class="macro">tiny_vec!</span>([<span class="ident">u8</span>; <span class="number">16</span>]);
|
||
<span class="kw">let</span> <span class="ident">some_ints</span> <span class="op">=</span> <span class="macro">tiny_vec!</span>([<span class="ident">i32</span>; <span class="number">4</span>] => <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>);
|
||
<span class="kw">let</span> <span class="ident">many_ints</span> <span class="op">=</span> <span class="macro">tiny_vec!</span>([<span class="ident">i32</span>; <span class="number">4</span>] => <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">10</span>);
|
||
|
||
<span class="comment">// Or left to inference</span>
|
||
<span class="kw">let</span> <span class="ident">empty_tv</span>: <span class="ident">TinyVec</span><span class="op"><</span>[<span class="ident">u8</span>; <span class="number">16</span>]<span class="op">></span> <span class="op">=</span> <span class="macro">tiny_vec!</span>();
|
||
<span class="kw">let</span> <span class="ident">some_ints</span>: <span class="ident">TinyVec</span><span class="op"><</span>[<span class="ident">i32</span>; <span class="number">4</span>]<span class="op">></span> <span class="op">=</span> <span class="macro">tiny_vec!</span>(<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>);
|
||
<span class="kw">let</span> <span class="ident">many_ints</span>: <span class="ident">TinyVec</span><span class="op"><</span>[<span class="ident">i32</span>; <span class="number">4</span>]<span class="op">></span> <span class="op">=</span> <span class="macro">tiny_vec!</span>(<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>, <span class="number">10</span>);</code></pre></div>
|
||
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tinyvec" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |