abstreet/rustdoc/abstutil/collections/index.html

15 lines
6.0 KiB
HTML
Raw Normal View History

<!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 `collections` mod in crate `abstutil`."><meta name="keywords" content="rust, rustlang, rust-lang, collections"><title>abstutil::collections - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><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='../../abstutil/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module collections</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>abstutil</a></p><script>window.sidebarCurrent = {name: 'collections', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><span class="help-button">?</span>
<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/abstutil/collections.rs.html#1-330' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>abstutil</a>::<wbr><a class="mod" href=''>collections</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.Counter.html" title='abstutil::collections::Counter struct'>Counter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.FixedMap.html" title='abstutil::collections::FixedMap struct'>FixedMap</a></td><td class='docblock-short'><p>A drop-in replacement for <code>BTreeMap</code>, where the keys have the property of being array indices.
Some values may be missing. Much more efficient at operations on individual objects, because
it just becomes a simple array lookup.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MultiMap.html" title='abstutil::collections::MultiMap struct'>MultiMap</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Tags.html" title='abstutil::collections::Tags struct'>Tags</a></td><td class='docblock-short'><p>Convenience functions around a string-&gt;string map</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.VecMap.html" title='abstutil::collections::VecMap struct'>VecMap</a></td><td class='docblock-short'><p>Use when your key is just PartialEq, not Ord or Hash.</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.IndexableKey.html" title='abstutil::collections::IndexableKey trait'>IndexableKey</a></td><td class='docblock-short'><p>Use with <code>FixedMap</code>. From a particular key, extract a <code>usize</code>. These values should be
roughly contiguous; the space used by the <code>FixedMap</code> will be <code>O(n)</code> with respect to the largest
value returned here.</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.contains_duplicates.html" title='abstutil::collections::contains_duplicates fn'>contains_duplicates</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.retain_btreemap.html" title='abstutil::collections::retain_btreemap fn'>retain_btreemap</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.retain_btreeset.html" title='abstutil::collections::retain_btreeset fn'>retain_btreeset</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.wraparound_get.html" title='abstutil::collections::wraparound_get fn'>wraparound_get</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "abstutil";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>