edlang/tinyvec/macro.tiny_vec.html
2024-03-11 08:39:13 +00:00

23 lines
6.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="Helper to make a `TinyVec`."><title>tiny_vec in tinyvec - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="tinyvec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../tinyvec/index.html">tinyvec</a><span class="version">1.6.0</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../tinyvec/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Macro <a href="index.html">tinyvec</a>::<wbr><a class="macro" href="#">tiny_vec</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/tinyvec/tinyvec.rs.html#39-68">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules! </span>tiny_vec {
(<span class="macro-nonterminal">$array_type</span>:ty =&gt; $(<span class="macro-nonterminal">$elem</span>:expr),* $(,)<span class="question-mark">?</span>) =&gt; { ... };
(<span class="macro-nonterminal">$array_type</span>:ty) =&gt; { ... };
($(<span class="macro-nonterminal">$elem</span>:expr),<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$elem</span>:expr; <span class="macro-nonterminal">$n</span>:expr) =&gt; { ... };
() =&gt; { ... };
}</pre><details class="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>tinyvec::<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>empty_tv = <span class="macro">tiny_vec!</span>([u8; <span class="number">16</span>]);
<span class="kw">let </span>some_ints = <span class="macro">tiny_vec!</span>([i32; <span class="number">4</span>] =&gt; <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>);
<span class="kw">let </span>many_ints = <span class="macro">tiny_vec!</span>([i32; <span class="number">4</span>] =&gt; <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>empty_tv: TinyVec&lt;[u8; <span class="number">16</span>]&gt; = <span class="macro">tiny_vec!</span>();
<span class="kw">let </span>some_ints: TinyVec&lt;[i32; <span class="number">4</span>]&gt; = <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>many_ints: TinyVec&lt;[i32; <span class="number">4</span>]&gt; = <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></div></main></body></html>