|
|
|
|
|
<!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="API documentation for the Rust `generic_array` crate."><meta name="keywords" content="rust, rustlang, rust-lang, generic_array"><title>generic_array - 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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../generic_array/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate generic_array</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all generic_array's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'generic_array', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><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><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/generic_array/lib.rs.html#1-632' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>generic_array</a></span></h1><div class='docblock'><p>This crate implements a structure that can be used as a generic array type.use
|
|
|
|
|
|
Core Rust array types <code>[T; N]</code> can't be used generically with
|
|
|
|
|
|
respect to <code>N</code>, so for example this:</p>
|
|
|
|
|
|
<pre><code class="language-{should_fail}">struct Foo<T, N> {
|
|
|
|
|
|
data: [T; N]
|
|
|
|
|
|
}
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
<p>won't work.</p>
|
|
|
|
|
|
<p><strong>generic-array</strong> exports a <code>GenericArray<T,N></code> type, which lets
|
|
|
|
|
|
the above be implemented as:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">struct</span> <span class="ident">Foo</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">N</span>: <span class="ident">ArrayLength</span><span class="op"><</span><span class="ident">T</span><span class="op">></span><span class="op">></span> {
|
|
|
|
|
|
<span class="ident">data</span>: <span class="ident">GenericArray</span><span class="op"><</span><span class="ident">T</span>,<span class="ident">N</span><span class="op">></span>
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
<p>The <code>ArrayLength<T></code> trait is implemented by default for
|
|
|
|
|
|
<a href="../typenum/uint/index.html">unsigned integer types</a> from
|
|
|
|
|
|
<a href="../typenum/index.html">typenum</a>.</p>
|
|
|
|
|
|
<p>For ease of use, an <code>arr!</code> macro is provided - example below:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">array</span> <span class="op">=</span> <span class="macro">arr</span><span class="macro">!</span>[<span class="ident">u32</span>; <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">array</span>[<span class="number">2</span>], <span class="number">3</span>);</pre></div>
|
|
|
|
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|
|
|
|
|
<table><tr><td><code>pub extern crate <a class="mod" href="../typenum/index.html" title="mod typenum">typenum</a>;</code></td></tr><tr><td><code>pub use iter::<a class="struct" href="../generic_array/iter/struct.GenericArrayIter.html" title="struct generic_array::iter::GenericArrayIter">GenericArrayIter</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="mod" href="arr/index.html" title='generic_array::arr mod'>arr</a></td><td class='docblock-short'><p>Implementation for <code>arr!</code> macro.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="functional/index.html" title='generic_array::functional mod'>functional</a></td><td class='docblock-short'><p>Functional programming with generic sequences</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="iter/index.html" title='generic_array::iter mod'>iter</a></td><td class='docblock-short'><p><code>GenericArray</code> iterator implementation.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="sequence/index.html" title='generic_array::sequence mod'>sequence</a></td><td class='docblock-short'><p>Useful traits for manipulating sequences of data stored in <code>GenericArray</code>s</p>
|
|
|
|
|
|
</td></tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="macro" href="macro.arr.html" title='generic_array::arr macro'>arr</a></td><td class='docblock-short'><p>Macro allowing for easy generation of Generic Arrays.
|
|
|
|
|
|
Example: <code>let test = arr![u32; 1, 2, 3];</code></p>
|
|
|
|
|
|
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.GenericArray.html" title='generic_array::GenericArray struct'>GenericArray</a></td><td class='docblock-short'><p>Struct representing a generic array - <code>GenericArray<T, N></code> works like [T; N]</p>
|
|
|
|
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.ArrayLength.html" title='generic_array::ArrayLength trait'>ArrayLength</a></td><td class='docblock-short'><p>Trait making <code>GenericArray</code> work, marking types to be used as length of an array</p>
|
|
|
|
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "generic_array";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
