a-b-street/abstreet
1
1
Fork 0
mirror of https://github.com/a-b-street/abstreet.git synced 2024-12-02 12:58:12 +03:00
Code Issues Projects Releases Wiki Activity
c097381b61
abstreet/rustdoc/abstutil/index.html
dabreegster c097381b61 deploy: 1a63097e8a
2022-11-03 16:50:52 +00:00

17 lines
17 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="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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer 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></ul></div><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></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"><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"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></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-34">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><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></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><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><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><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><div class="item-row"><div class="item-left module-item"><a class="mod" href="priority_queue/index.html" title="abstutil::priority_queue mod">priority_queue</a><span title="Restricted Visibility">&nbsp;🔒</span> </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><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><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><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></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">A counter per key</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">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.</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><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PriorityQueueItem.html" title="abstutil::PriorityQueueItem struct">PriorityQueueItem</a></div><div class="item-right docblock-short">Use with <code>BinaryHeap</code>. Since it’s a max-heap, reverse the comparison to get the smallest cost
first.</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">Convenience functions around a string-&gt;string map</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">Use when your key is just PartialEq, not Ord or Hash.</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></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">Trick to make a cloneable Any from
https://stackoverflow.com/questions/30353462/how-to-clone-a-struct-storing-a-boxed-trait-object/30353928#30353928.</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><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">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.</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><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">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.</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><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">Returns arguments passed in from the command-line, starting with the program name.</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><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">Deserializes a BTreeMap from a list of tuples. Necessary when the keys are structs; see
https://github.com/serde-rs/json/issues/402.</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">Deserializes a HashMap from a list of tuples.</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">Deserializes a MultiMap.</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">Deserializes a <code>usize</code> from a <code>u32</code>.</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">Deserializes an object from the bincode format.</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">Deserializes an object from the bincode format, from a reader.</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">Deserializes an object from a JSON string.</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">Deserializes an object from JSON, from a reader.</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">Runs a command, asserts success. STDOUT and STDERR aren’t touched.</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><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><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><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><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">Serializes a BTreeMap as a list of tuples. Necessary when the keys are structs; see
https://github.com/serde-rs/json/issues/402.</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">Serializes a HashMap as a list of tuples, first sorting by the keys. This ensures the
serialized form is deterministic.</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">Serializes a MultiMap.</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">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 don’t exceed 2^32.</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">The number of bytes for an object serialized to bincode.</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">Transforms an object to bincoded bytes.</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">Stringifies an object to nicely formatted JSON.</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">Stringifies an object to terse JSON.</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></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.65.0 (897e37553 2022-11-02)" ></div></body></html>
Reference in New Issue View Git Blame Copy Permalink