219 lines
No EOL
8.7 KiB
HTML
219 lines
No EOL
8.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="API documentation for the Rust `arrayvec` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, arrayvec">
|
||
|
||
<title>arrayvec - 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="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<p class='location'>Crate arrayvec</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'arrayvec', 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">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>arrayvec</a></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/arrayvec/lib.rs.html#1-1067' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p><strong>arrayvec</strong> provides the types <code>ArrayVec</code> and <code>ArrayString</code>:
|
||
array-backed vector and string types, which store their contents inline.</p>
|
||
<p>The arrayvec package has the following cargo features:</p>
|
||
<ul>
|
||
<li>
|
||
<p><code>std</code></p>
|
||
<ul>
|
||
<li>Optional, enabled by default</li>
|
||
<li>Use libstd; disable to use <code>no_std</code> instead.</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><code>use_union</code></p>
|
||
<ul>
|
||
<li>Optional</li>
|
||
<li>Requires Rust nightly channel</li>
|
||
<li>Experimental: This flag uses nightly so it <em>may break</em> unexpectedly
|
||
at some point; since it doesn't change API this flag may also change
|
||
to do nothing in the future.</li>
|
||
<li>Use the unstable feature untagged unions for the internal implementation,
|
||
which may have reduced space overhead</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><code>serde-1</code></p>
|
||
<ul>
|
||
<li>Optional</li>
|
||
<li>Enable serialization for ArrayVec and ArrayString using serde 1.0</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id="rust-version" class="section-header"><a href="#rust-version">Rust Version</a></h2>
|
||
<p>This version of arrayvec requires Rust 1.13 or later.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ArrayString.html"
|
||
title='struct arrayvec::ArrayString'>ArrayString</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A string with a fixed capacity.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ArrayVec.html"
|
||
title='struct arrayvec::ArrayVec'>ArrayVec</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A vector with a fixed capacity.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.CapacityError.html"
|
||
title='struct arrayvec::CapacityError'>CapacityError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error value indicating insufficient capacity</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Drain.html"
|
||
title='struct arrayvec::Drain'>Drain</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A draining iterator for <code>ArrayVec</code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.IntoIter.html"
|
||
title='struct arrayvec::IntoIter'>IntoIter</a></td>
|
||
<td class='docblock-short'>
|
||
<p>By-value iterator for <code>ArrayVec</code>.</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.Array.html"
|
||
title='trait arrayvec::Array'>Array</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Trait for fixed size arrays.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.RangeArgument.html"
|
||
title='trait arrayvec::RangeArgument'>RangeArgument</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>RangeArgument</code> is implemented by Rust's built-in range types, produced
|
||
by range syntax like <code>..</code>, <code>a..</code>, <code>..b</code> or <code>c..d</code>.</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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "arrayvec";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |