Files
Trac3r-rust/doc/linked_hash_map/index.html
2020-01-23 23:13:36 -08:00

31 lines
9.2 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 `linked_hash_map` crate."><meta name="keywords" content="rust, rustlang, rust-lang, linked_hash_map"><title>linked_hash_map - 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">&#9776;</div><a href='../linked_hash_map/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate linked_hash_map</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all linked_hash_map's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'linked_hash_map', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/linked_hash_map/lib.rs.html#11-1343' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>linked_hash_map</a></span></h1><div class='docblock'><p>A <code>HashMap</code> wrapper that holds key-value pairs in insertion order.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">linked_hash_map</span>::<span class="ident">LinkedHashMap</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">LinkedHashMap</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="number">2</span>, <span class="number">20</span>);
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="number">1</span>, <span class="number">10</span>);
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="number">3</span>, <span class="number">30</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="kw-2">&amp;</span><span class="number">1</span>], <span class="number">10</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="kw-2">&amp;</span><span class="number">2</span>], <span class="number">20</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="kw-2">&amp;</span><span class="number">3</span>], <span class="number">30</span>);
<span class="kw">let</span> <span class="ident">items</span>: <span class="ident">Vec</span><span class="op">&lt;</span>(<span class="ident">i32</span>, <span class="ident">i32</span>)<span class="op">&gt;</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">t</span><span class="op">|</span> (<span class="kw-2">*</span><span class="ident">t</span>.<span class="number">0</span>, <span class="kw-2">*</span><span class="ident">t</span>.<span class="number">1</span>)).<span class="ident">collect</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">items</span>, [(<span class="number">2</span>, <span class="number">20</span>), (<span class="number">1</span>, <span class="number">10</span>), (<span class="number">3</span>, <span class="number">30</span>)]);</pre></div>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.Entries.html" title='linked_hash_map::Entries struct'>Entries</a></td><td class='docblock-short'><p>An insertion-order iterator over a <code>LinkedHashMap</code>'s entries represented as
an <code>OccupiedEntry</code>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IntoIter.html" title='linked_hash_map::IntoIter struct'>IntoIter</a></td><td class='docblock-short'><p>A consuming insertion-order iterator over a <code>LinkedHashMap</code>'s entries.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Iter.html" title='linked_hash_map::Iter struct'>Iter</a></td><td class='docblock-short'><p>An insertion-order iterator over a <code>LinkedHashMap</code>'s entries, with immutable references to the
values.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.IterMut.html" title='linked_hash_map::IterMut struct'>IterMut</a></td><td class='docblock-short'><p>An insertion-order iterator over a <code>LinkedHashMap</code>'s entries, with mutable references to the
values.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Keys.html" title='linked_hash_map::Keys struct'>Keys</a></td><td class='docblock-short'><p>An insertion-order iterator over a <code>LinkedHashMap</code>'s keys.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LinkedHashMap.html" title='linked_hash_map::LinkedHashMap struct'>LinkedHashMap</a></td><td class='docblock-short'><p>A linked hash map.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.OccupiedEntry.html" title='linked_hash_map::OccupiedEntry struct'>OccupiedEntry</a></td><td class='docblock-short'><p>A view into a single occupied location in a <code>LinkedHashMap</code>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.VacantEntry.html" title='linked_hash_map::VacantEntry struct'>VacantEntry</a></td><td class='docblock-short'><p>A view into a single empty location in a <code>LinkedHashMap</code>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Values.html" title='linked_hash_map::Values struct'>Values</a></td><td class='docblock-short'><p>An insertion-order iterator over a <code>LinkedHashMap</code>'s values.</p>
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.Entry.html" title='linked_hash_map::Entry enum'>Entry</a></td><td class='docblock-short'><p>A view into a single location in a map, which may be vacant or occupied.</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>&#9166;</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 = "linked_hash_map";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>