oxipng/doc/bitflags/__core/vec/index.html
2016-05-04 10:41:29 -04:00

176 lines
No EOL
8.6 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="API documentation for the Rust `vec` mod in crate `bitflags`.">
<meta name="keywords" content="rust, rustlang, rust-lang, vec">
<title>bitflags::__core::vec - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a></p><script>window.sidebarCurrent = {name: 'vec', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<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 mod">
<h1 class='fqn'><span class='in-band'>Module <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a class='mod' href=''>vec</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'>&#x2212;</span>]
</a>
</span><a id='src-4028' class='srclink' href='https://doc.rust-lang.org/nightly/collections/vec/index.html?gotosrc=4028' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A contiguous growable array type with heap-allocated contents, written
<code>Vec&lt;T&gt;</code> but pronounced &#39;vector.&#39;</p>
<p>Vectors have <code>O(1)</code> indexing, amortized <code>O(1)</code> push (to the end) and
<code>O(1)</code> pop (from the end).</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<p>You can explicitly create a <code>Vec&lt;T&gt;</code> with <code>new()</code>:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>v</span>: <span class='ident'>Vec</span><span class='op'>&lt;</span><span class='ident'>i32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>Vec</span>::<span class='ident'>new</span>();</pre>
<p>...or by using the <code>vec!</code> macro:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>v</span>: <span class='ident'>Vec</span><span class='op'>&lt;</span><span class='ident'>i32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[];
<span class='kw'>let</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</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='kw'>let</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>0</span>; <span class='number'>10</span>]; <span class='comment'>// ten zeroes</span></pre>
<p>You can <code>push</code> values onto the end of a vector (which will grow the vector
as needed):</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>];
<span class='ident'>v</span>.<span class='ident'>push</span>(<span class='number'>3</span>);</pre>
<p>Popping values works in much the same way:</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>];
<span class='kw'>let</span> <span class='ident'>two</span> <span class='op'>=</span> <span class='ident'>v</span>.<span class='ident'>pop</span>();</pre>
<p>Vectors also support indexing (through the <code>Index</code> and <code>IndexMut</code> traits):</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>];
<span class='kw'>let</span> <span class='ident'>three</span> <span class='op'>=</span> <span class='ident'>v</span>[<span class='number'>2</span>];
<span class='ident'>v</span>[<span class='number'>1</span>] <span class='op'>=</span> <span class='ident'>v</span>[<span class='number'>1</span>] <span class='op'>+</span> <span class='number'>5</span>;</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.Drain.html'
title='bitflags::__core::vec::Drain'>Drain</a></td>
<td class='docblock short'>
<p>A draining iterator for <code>Vec&lt;T&gt;</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.IntoIter.html'
title='bitflags::__core::vec::IntoIter'>IntoIter</a></td>
<td class='docblock short'>
<p>An iterator that moves out of a vector.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Vec.html'
title='bitflags::__core::vec::Vec'>Vec</a></td>
<td class='docblock short'>
<p>A contiguous growable array type, written <code>Vec&lt;T&gt;</code> but pronounced &#39;vector.&#39;</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</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 = "bitflags";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>