1
1
mirror of https://github.com/a-b-street/abstreet.git synced 2024-12-22 22:01:41 +03:00
abstreet/rustdoc/abstutil/index.html

54 lines
18 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="The contents of this crate need to be organized better:"><meta name="keywords" content="rust, rustlang, rust-lang, abstutil"><title>abstutil - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../abstutil/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../abstutil/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Crate abstutil</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div></section><div id="sidebar-vars" data-name="abstutil" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../abstutil/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">abstutil</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/abstutil/lib.rs.html#1-32">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The contents of this crate need to be organized better:</p>
<ul>
<li>Timer (a mix of logging, profiling, and even parallel execution)</li>
<li>true utility functions (collections, prettyprinting, CLI parsing</li>
</ul>
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use <a class="mod" href="logger/index.html" title="mod abstutil::logger">logger</a>::*;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use <a class="mod" href="time/index.html" title="mod abstutil::time">time</a>::*;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="cli/index.html" title="abstutil::cli mod">cli</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="clone/index.html" title="abstutil::clone mod">clone</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="collections/index.html" title="abstutil::collections mod">collections</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="logger/index.html" title="abstutil::logger mod">logger</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="process/index.html" title="abstutil::process mod">process</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="serde/index.html" title="abstutil::serde mod">serde</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="time/index.html" title="abstutil::time mod">time</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="utils/index.html" title="abstutil::utils mod">utils</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Counter.html" title="abstutil::Counter struct">Counter</a></div><div class="item-right docblock-short"><p>A counter per key</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FixedMap.html" title="abstutil::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><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MultiMap.html" title="abstutil::MultiMap struct">MultiMap</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Tags.html" title="abstutil::Tags struct">Tags</a></div><div class="item-right docblock-short"><p>Convenience functions around a string-&gt;string map</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VecMap.html" title="abstutil::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></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PROGRESS_FREQUENCY_SECONDS.html" title="abstutil::PROGRESS_FREQUENCY_SECONDS constant">PROGRESS_FREQUENCY_SECONDS</a></div><div class="item-right docblock-short"></div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CloneableAny.html" title="abstutil::CloneableAny trait">CloneableAny</a></div><div class="item-right docblock-short"><p>Trick to make a cloneable Any from
https://stackoverflow.com/questions/30353462/how-to-clone-a-struct-storing-a-boxed-trait-object/30353928#30353928.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CloneableImpl.html" title="abstutil::CloneableImpl trait">CloneableImpl</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.IndexableKey.html" title="abstutil::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></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.abbreviated_format.html" title="abstutil::abbreviated_format fn">abbreviated_format</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.args_to_query_string.html" title="abstutil::args_to_query_string fn">args_to_query_string</a></div><div class="item-right docblock-short"><p>Transforms some command-line arguments into URL query parameters, using <code>&amp;</code> as the separator
between arguments. The string returned starts with <code>?</code>, unless the arguments are all empty.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.basename.html" title="abstutil::basename fn">basename</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cli_args.html" title="abstutil::cli_args fn">cli_args</a></div><div class="item-right docblock-short"><p>Returns arguments passed in from the command-line, starting with the program name.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.contains_duplicates.html" title="abstutil::contains_duplicates fn">contains_duplicates</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.deserialize_btreemap.html" title="abstutil::deserialize_btreemap fn">deserialize_btreemap</a></div><div class="item-right docblock-short"><p>Deserializes a BTreeMap from a list of tuples. Necessary when the keys are structs; see
https://github.com/serde-rs/json/issues/402.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.deserialize_hashmap.html" title="abstutil::deserialize_hashmap fn">deserialize_hashmap</a></div><div class="item-right docblock-short"><p>Deserializes a HashMap from a list of tuples.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.deserialize_multimap.html" title="abstutil::deserialize_multimap fn">deserialize_multimap</a></div><div class="item-right docblock-short"><p>Deserializes a MultiMap.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.deserialize_usize.html" title="abstutil::deserialize_usize fn">deserialize_usize</a></div><div class="item-right docblock-short"><p>Deserializes a <code>usize</code> from a <code>u32</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_binary.html" title="abstutil::from_binary fn">from_binary</a></div><div class="item-right docblock-short"><p>Deserializes an object from the bincode format.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_binary_reader.html" title="abstutil::from_binary_reader fn">from_binary_reader</a></div><div class="item-right docblock-short"><p>Deserializes an object from the bincode format, from a reader.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_json.html" title="abstutil::from_json fn">from_json</a></div><div class="item-right docblock-short"><p>Deserializes an object from a JSON string.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_json_reader.html" title="abstutil::from_json_reader fn">from_json_reader</a></div><div class="item-right docblock-short"><p>Deserializes an object from JSON, from a reader.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.must_run_cmd.html" title="abstutil::must_run_cmd fn">must_run_cmd</a></div><div class="item-right docblock-short"><p>Runs a command, asserts success. STDOUT and STDERR arent touched.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.parent_path.html" title="abstutil::parent_path fn">parent_path</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.plain_list_names.html" title="abstutil::plain_list_names fn">plain_list_names</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.prettyprint_bytes.html" title="abstutil::prettyprint_bytes fn">prettyprint_bytes</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.prettyprint_usize.html" title="abstutil::prettyprint_usize fn">prettyprint_usize</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_btreemap.html" title="abstutil::serialize_btreemap fn">serialize_btreemap</a></div><div class="item-right docblock-short"><p>Serializes a BTreeMap as a list of tuples. Necessary when the keys are structs; see
https://github.com/serde-rs/json/issues/402.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_hashmap.html" title="abstutil::serialize_hashmap fn">serialize_hashmap</a></div><div class="item-right docblock-short"><p>Serializes a HashMap as a list of tuples, first sorting by the keys. This ensures the
serialized form is deterministic.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_multimap.html" title="abstutil::serialize_multimap fn">serialize_multimap</a></div><div class="item-right docblock-short"><p>Serializes a MultiMap.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_usize.html" title="abstutil::serialize_usize fn">serialize_usize</a></div><div class="item-right docblock-short"><p>Serializes a <code>usize</code> as a <code>u32</code> to save space. Useful when you need <code>usize</code> for indexing, but
the values dont exceed 2^32.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialized_size_bytes.html" title="abstutil::serialized_size_bytes fn">serialized_size_bytes</a></div><div class="item-right docblock-short"><p>The number of bytes for an object serialized to bincode.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_binary.html" title="abstutil::to_binary fn">to_binary</a></div><div class="item-right docblock-short"><p>Transforms an object to bincoded bytes.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_json.html" title="abstutil::to_json fn">to_json</a></div><div class="item-right docblock-short"><p>Stringifies an object to nicely formatted JSON.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.to_json_terse.html" title="abstutil::to_json_terse fn">to_json_terse</a></div><div class="item-right docblock-short"><p>Stringifies an object to terse JSON.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.wraparound_get.html" title="abstutil::wraparound_get fn">wraparound_get</a></div><div class="item-right docblock-short"></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="abstutil" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.62.0 (a8314ef7d 2022-06-27)" ></div>
</body></html>