abstreet/rustdoc/abstutil/collections/index.html
2021-09-09 16:19:47 +00:00

14 lines
6.1 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 `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 id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.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 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../abstutil/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module collections</h2><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><div id="sidebar-vars" data-name="collections" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">abstutil</a>::<wbr><a class="mod" href="#">collections</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></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 class="srclink" href="../../src/abstutil/collections.rs.html#1-384" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="struct" href="struct.Counter.html" title="abstutil::collections::Counter struct">Counter</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.FixedMap.html" title="abstutil::collections::FixedMap struct">FixedMap</a></div><div class="item-right 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>
</div><div class="item-left module-item"><a class="struct" href="struct.MultiMap.html" title="abstutil::collections::MultiMap struct">MultiMap</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="struct" href="struct.Tags.html" title="abstutil::collections::Tags struct">Tags</a></div><div class="item-right docblock-short"><p>Convenience functions around a string-&gt;string map</p>
</div><div class="item-left module-item"><a class="struct" href="struct.VecMap.html" title="abstutil::collections::VecMap struct">VecMap</a></div><div class="item-right docblock-short"><p>Use when your key is just PartialEq, not Ord or Hash.</p>
</div></div><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="trait" href="trait.IndexableKey.html" title="abstutil::collections::IndexableKey trait">IndexableKey</a></div><div class="item-right 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>
</div></div><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-left module-item"><a class="fn" href="fn.contains_duplicates.html" title="abstutil::collections::contains_duplicates fn">contains_duplicates</a></div><div class="item-right docblock-short"></div><div class="item-left module-item"><a class="fn" href="fn.wraparound_get.html" title="abstutil::collections::wraparound_get fn">wraparound_get</a></div><div class="item-right docblock-short"></div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="abstutil" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
<script src="../../main.js"></script>
</body></html>