mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-21 05:11:42 +03:00
175 lines
66 KiB
HTML
175 lines
66 KiB
HTML
<!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 `Command` enum in crate `cli`."><meta name="keywords" content="rust, rustlang, rust-lang, Command"><title>Command in cli - 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="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"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc enum"><!--[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">☰</div><a href='../cli/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Enum Command</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#variants">Variants</a></h3><div class="sidebar-links"><a href="#variant.AugmentScenario">AugmentScenario</a><a href="#variant.ClipOSM">ClipOSM</a><a href="#variant.DumpJSON">DumpJSON</a><a href="#variant.GenerateHouses">GenerateHouses</a><a href="#variant.GeoJSONToOsmosis">GeoJSONToOsmosis</a><a href="#variant.Import">Import</a><a href="#variant.ImportGrid2Demand">ImportGrid2Demand</a><a href="#variant.ImportJSONMap">ImportJSONMap</a><a href="#variant.ImportScenario">ImportScenario</a><a href="#variant.MinifyMap">MinifyMap</a><a href="#variant.OneStepImport">OneStepImport</a><a href="#variant.OneshotImport">OneshotImport</a><a href="#variant.PickGeofabrik">PickGeofabrik</a><a href="#variant.RandomScenario">RandomScenario</a><a href="#variant.RegenerateAllMaps">RegenerateAllMaps</a><a href="#variant.RegenerateEverything">RegenerateEverything</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-StructOpt">StructOpt</a></div><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-Downcast">Downcast</a><a href="#impl-DowncastSync">DowncastSync</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></a></div></div><h2 class="location">Other items in<br><a href="index.html">cli</a></h2><div id="sidebar-vars" data-name="Command" data-ty="enum" 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">Enum <a href="index.html">cli</a>::<wbr><a class="enum" href="#">Command</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><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">−</span>]</a></span><a class="srclink" href="../src/cli/main.rs.html#23-200" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust enum"><code>pub(crate) enum Command {
|
||
<details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 16 variants</span></summary> DumpJSON {
|
||
path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
RandomScenario {
|
||
rng_seed: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.u64.html">u64</a>,
|
||
map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
scenario_name: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
AugmentScenario {
|
||
input_scenario: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
add_return_trips: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
add_lunch_trips: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
rng_seed: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.u64.html">u64</a>,
|
||
},
|
||
ClipOSM {
|
||
pbf_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
clip_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
out_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
GeoJSONToOsmosis {
|
||
input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
ImportGrid2Demand {
|
||
input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
ImportScenario {
|
||
input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
skip_problems: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
},
|
||
ImportJSONMap {
|
||
input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
output: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
MinifyMap {
|
||
map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
GenerateHouses {
|
||
map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
num_required: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a>,
|
||
rng_seed: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.u64.html">u64</a>,
|
||
output: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
PickGeofabrik {
|
||
input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
},
|
||
OneStepImport {
|
||
geojson_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
map_name: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
drive_on_left: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
use_geofabrik: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
filter_crosswalks: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
},
|
||
OneshotImport {
|
||
osm_input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
clip_path: <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>,
|
||
drive_on_left: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
filter_crosswalks: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a>,
|
||
opts: <a class="struct" href="../map_model/make/struct.RawToMapOptions.html" title="struct map_model::make::RawToMapOptions">RawToMapOptions</a>,
|
||
},
|
||
RegenerateEverything {
|
||
shard_num: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a>,
|
||
num_shards: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a>,
|
||
},
|
||
RegenerateAllMaps,
|
||
Import {
|
||
job: <a class="struct" href="../importer/struct.Job.html" title="struct importer::Job">Job</a>,
|
||
},
|
||
</details>}</code></pre></div><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><div id="variant.DumpJSON" class="variant small-section-header"><a href="#variant.DumpJSON" class="anchor field"></a><code>DumpJSON</code></div><div class="docblock"><p>Print a binary map or scenario file as JSON</p>
|
||
</div><div class="sub-variant" id="variant.DumpJSON.fields"><h3>Fields of <b>DumpJSON</b></h3><div><span id="variant.DumpJSON.field.path" class="variant small-section-header"><a href="#variant.DumpJSON.field.path" class="anchor field"></a><code>path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></div></div><div id="variant.RandomScenario" class="variant small-section-header"><a href="#variant.RandomScenario" class="anchor field"></a><code>RandomScenario</code></div><div class="docblock"><p>Generates a random scenario using the proletariat robot travel demand model</p>
|
||
</div><div class="sub-variant" id="variant.RandomScenario.fields"><h3>Fields of <b>RandomScenario</b></h3><div><span id="variant.RandomScenario.field.rng_seed" class="variant small-section-header"><a href="#variant.RandomScenario.field.rng_seed" class="anchor field"></a><code>rng_seed: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.u64.html">u64</a></code></span><div class="docblock"><p>A seed for generating random numbers</p>
|
||
</div><span id="variant.RandomScenario.field.map" class="variant small-section-header"><a href="#variant.RandomScenario.field.map" class="anchor field"></a><code>map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a map to generate a scenario for</p>
|
||
</div><span id="variant.RandomScenario.field.scenario_name" class="variant small-section-header"><a href="#variant.RandomScenario.field.scenario_name" class="anchor field"></a><code>scenario_name: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The name of the scenario to generate</p>
|
||
</div></div></div><div id="variant.AugmentScenario" class="variant small-section-header"><a href="#variant.AugmentScenario" class="anchor field"></a><code>AugmentScenario</code></div><div class="docblock"><p>Modifies the schedule of every person in an existing scenario.</p>
|
||
</div><div class="sub-variant" id="variant.AugmentScenario.fields"><h3>Fields of <b>AugmentScenario</b></h3><div><span id="variant.AugmentScenario.field.input_scenario" class="variant small-section-header"><a href="#variant.AugmentScenario.field.input_scenario" class="anchor field"></a><code>input_scenario: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a scenario to augment. This will be modified in-place.</p>
|
||
<p>This tool isn’t very smart about detecting if a scenario already has these extra trips added
|
||
in; be careful about running this on the correct input.</p>
|
||
</div><span id="variant.AugmentScenario.field.add_return_trips" class="variant small-section-header"><a href="#variant.AugmentScenario.field.add_return_trips" class="anchor field"></a><code>add_return_trips: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>For people with only a single trip, add a return trip back home sometime 4-12 hours
|
||
later</p>
|
||
</div><span id="variant.AugmentScenario.field.add_lunch_trips" class="variant small-section-header"><a href="#variant.AugmentScenario.field.add_lunch_trips" class="anchor field"></a><code>add_lunch_trips: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Before a person’s final trp home, insert a round-trip to a nearby cafe or restaurant</p>
|
||
</div><span id="variant.AugmentScenario.field.rng_seed" class="variant small-section-header"><a href="#variant.AugmentScenario.field.rng_seed" class="anchor field"></a><code>rng_seed: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.u64.html">u64</a></code></span><div class="docblock"><p>A seed for generating random numbers</p>
|
||
</div></div></div><div id="variant.ClipOSM" class="variant small-section-header"><a href="#variant.ClipOSM" class="anchor field"></a><code>ClipOSM</code></div><div class="docblock"><p>Clips an OSM file to a boundary. This is a simple Rust port of <code>osmconvert large_map.osm -B=clipping.poly --complete-ways -o=smaller_map.osm</code>.</p>
|
||
</div><div class="sub-variant" id="variant.ClipOSM.fields"><h3>Fields of <b>ClipOSM</b></h3><div><span id="variant.ClipOSM.field.pbf_path" class="variant small-section-header"><a href="#variant.ClipOSM.field.pbf_path" class="anchor field"></a><code>pbf_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to the input .osm.pbf file</p>
|
||
</div><span id="variant.ClipOSM.field.clip_path" class="variant small-section-header"><a href="#variant.ClipOSM.field.clip_path" class="anchor field"></a><code>clip_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to an Osmosis boundary polygon</p>
|
||
</div><span id="variant.ClipOSM.field.out_path" class="variant small-section-header"><a href="#variant.ClipOSM.field.out_path" class="anchor field"></a><code>out_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to write the XML results</p>
|
||
</div></div></div><div id="variant.GeoJSONToOsmosis" class="variant small-section-header"><a href="#variant.GeoJSONToOsmosis" class="anchor field"></a><code>GeoJSONToOsmosis</code></div><div class="docblock"><p>Reads a GeoJSON file, extracts a polygon from every feature, and writes numbered files in
|
||
the https://wiki.openstreetmap.org/wiki/Osmosis/Polygon_Filter_File_Format format as
|
||
output.</p>
|
||
</div><div class="sub-variant" id="variant.GeoJSONToOsmosis.fields"><h3>Fields of <b>GeoJSONToOsmosis</b></h3><div><span id="variant.GeoJSONToOsmosis.field.input" class="variant small-section-header"><a href="#variant.GeoJSONToOsmosis.field.input" class="anchor field"></a><code>input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a GeoJSON file</p>
|
||
</div></div></div><div id="variant.ImportGrid2Demand" class="variant small-section-header"><a href="#variant.ImportGrid2Demand" class="anchor field"></a><code>ImportGrid2Demand</code></div><div class="docblock"><p>Import a scenario from https://github.com/asu-trans-ai-lab/grid2demand.</p>
|
||
</div><div class="sub-variant" id="variant.ImportGrid2Demand.fields"><h3>Fields of <b>ImportGrid2Demand</b></h3><div><span id="variant.ImportGrid2Demand.field.input" class="variant small-section-header"><a href="#variant.ImportGrid2Demand.field.input" class="anchor field"></a><code>input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a grid2demand CSV file</p>
|
||
</div><span id="variant.ImportGrid2Demand.field.map" class="variant small-section-header"><a href="#variant.ImportGrid2Demand.field.map" class="anchor field"></a><code>map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a map matching the grid2demand data</p>
|
||
</div></div></div><div id="variant.ImportScenario" class="variant small-section-header"><a href="#variant.ImportScenario" class="anchor field"></a><code>ImportScenario</code></div><div class="docblock"><p>Import a JSON scenario in the
|
||
https://a-b-street.github.io/docs/tech/dev/formats/scenarios.html format</p>
|
||
</div><div class="sub-variant" id="variant.ImportScenario.fields"><h3>Fields of <b>ImportScenario</b></h3><div><span id="variant.ImportScenario.field.input" class="variant small-section-header"><a href="#variant.ImportScenario.field.input" class="anchor field"></a><code>input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a JSON scenario file</p>
|
||
</div><span id="variant.ImportScenario.field.map" class="variant small-section-header"><a href="#variant.ImportScenario.field.map" class="anchor field"></a><code>map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a map matching the scenario data</p>
|
||
</div><span id="variant.ImportScenario.field.skip_problems" class="variant small-section-header"><a href="#variant.ImportScenario.field.skip_problems" class="anchor field"></a><code>skip_problems: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Problems occur when a position is within the map boundary, but not close enough to
|
||
buildings. Skip people with problematic positions if true, abort otherwise.</p>
|
||
</div></div></div><div id="variant.ImportJSONMap" class="variant small-section-header"><a href="#variant.ImportJSONMap" class="anchor field"></a><code>ImportJSONMap</code></div><div class="docblock"><p>Transform a JSON map that’s been manually edited into the binary format suitable for
|
||
simulation.</p>
|
||
</div><div class="sub-variant" id="variant.ImportJSONMap.fields"><h3>Fields of <b>ImportJSONMap</b></h3><div><span id="variant.ImportJSONMap.field.input" class="variant small-section-header"><a href="#variant.ImportJSONMap.field.input" class="anchor field"></a><code>input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a JSON map file to import</p>
|
||
</div><span id="variant.ImportJSONMap.field.output" class="variant small-section-header"><a href="#variant.ImportJSONMap.field.output" class="anchor field"></a><code>output: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to write</p>
|
||
</div></div></div><div id="variant.MinifyMap" class="variant small-section-header"><a href="#variant.MinifyMap" class="anchor field"></a><code>MinifyMap</code></div><div class="docblock"><p>Removes nonessential parts of a Map, for the bike network tool.</p>
|
||
</div><div class="sub-variant" id="variant.MinifyMap.fields"><h3>Fields of <b>MinifyMap</b></h3><div><span id="variant.MinifyMap.field.map" class="variant small-section-header"><a href="#variant.MinifyMap.field.map" class="anchor field"></a><code>map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a map to shrink. The map is modified in-place.</p>
|
||
</div></div></div><div id="variant.GenerateHouses" class="variant small-section-header"><a href="#variant.GenerateHouses" class="anchor field"></a><code>GenerateHouses</code></div><div class="docblock"><p>Procedurally generates houses along empty residential roads of a map</p>
|
||
</div><div class="sub-variant" id="variant.GenerateHouses.fields"><h3>Fields of <b>GenerateHouses</b></h3><div><span id="variant.GenerateHouses.field.map" class="variant small-section-header"><a href="#variant.GenerateHouses.field.map" class="anchor field"></a><code>map: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a map to generate houses for</p>
|
||
</div><span id="variant.GenerateHouses.field.num_required" class="variant small-section-header"><a href="#variant.GenerateHouses.field.num_required" class="anchor field"></a><code>num_required: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a></code></span><div class="docblock"><p>If the tool doesn’t generate at least this many houses, then fail. This can be used to
|
||
autodetect if a map probably already has most houses tagged in OSM.</p>
|
||
</div><span id="variant.GenerateHouses.field.rng_seed" class="variant small-section-header"><a href="#variant.GenerateHouses.field.rng_seed" class="anchor field"></a><code>rng_seed: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.u64.html">u64</a></code></span><div class="docblock"><p>A seed for generating random numbers</p>
|
||
</div><span id="variant.GenerateHouses.field.output" class="variant small-section-header"><a href="#variant.GenerateHouses.field.output" class="anchor field"></a><code>output: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The GeoJSON file to write</p>
|
||
</div></div></div><div id="variant.PickGeofabrik" class="variant small-section-header"><a href="#variant.PickGeofabrik" class="anchor field"></a><code>PickGeofabrik</code></div><div class="docblock"><p>Prints the osm.pbf file from download.geofabrik.de that covers a given boundary.</p>
|
||
<p>This is a useful tool when importing a new map, if you don’t already know which geofabrik
|
||
file you should use as your OSM input.</p>
|
||
</div><div class="sub-variant" id="variant.PickGeofabrik.fields"><h3>Fields of <b>PickGeofabrik</b></h3><div><span id="variant.PickGeofabrik.field.input" class="variant small-section-header"><a href="#variant.PickGeofabrik.field.input" class="anchor field"></a><code>input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to an <a href="https://wiki.openstreetmap.org/wiki/Osmosis/Polygon_Filter_File_Format">osmosis polygon boundary
|
||
file</a></p>
|
||
</div></div></div><div id="variant.OneStepImport" class="variant small-section-header"><a href="#variant.OneStepImport" class="anchor field"></a><code>OneStepImport</code></div><div class="docblock"><p>Imports a one-shot A/B Street map from a GeoJSON boundary in a single command.</p>
|
||
</div><div class="sub-variant" id="variant.OneStepImport.fields"><h3>Fields of <b>OneStepImport</b></h3><div><span id="variant.OneStepImport.field.geojson_path" class="variant small-section-header"><a href="#variant.OneStepImport.field.geojson_path" class="anchor field"></a><code>geojson_path: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>The path to a GeoJSON file with a boundary</p>
|
||
</div><span id="variant.OneStepImport.field.map_name" class="variant small-section-header"><a href="#variant.OneStepImport.field.map_name" class="anchor field"></a><code>map_name: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>What to name the new imported map. The country will always be “zz” (a fake country
|
||
code), with the city as “oneshot.” This name shouldn’t contain spaces or be empty.</p>
|
||
</div><span id="variant.OneStepImport.field.drive_on_left" class="variant small-section-header"><a href="#variant.OneStepImport.field.drive_on_left" class="anchor field"></a><code>drive_on_left: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Do people drive on the left side of the road in this map?</p>
|
||
</div><span id="variant.OneStepImport.field.use_geofabrik" class="variant small-section-header"><a href="#variant.OneStepImport.field.use_geofabrik" class="anchor field"></a><code>use_geofabrik: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Use Geofabrik to grab OSM input if true, or Overpass if false. Overpass is faster.</p>
|
||
</div><span id="variant.OneStepImport.field.filter_crosswalks" class="variant small-section-header"><a href="#variant.OneStepImport.field.filter_crosswalks" class="anchor field"></a><code>filter_crosswalks: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Downgrade crosswalks not matching a <code>highway=crossing</code> OSM node into unmarked crossings.</p>
|
||
</div></div></div><div id="variant.OneshotImport" class="variant small-section-header"><a href="#variant.OneshotImport" class="anchor field"></a><code>OneshotImport</code></div><div class="docblock"><p>Imports a one-shot A/B Street map from an .osm file in a single command.</p>
|
||
</div><div class="sub-variant" id="variant.OneshotImport.fields"><h3>Fields of <b>OneshotImport</b></h3><div><span id="variant.OneshotImport.field.osm_input" class="variant small-section-header"><a href="#variant.OneshotImport.field.osm_input" class="anchor field"></a><code>osm_input: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><span id="variant.OneshotImport.field.clip_path" class="variant small-section-header"><a href="#variant.OneshotImport.field.clip_path" class="anchor field"></a><code>clip_path: <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span><div class="docblock"><p>The path to an Osmosis boundary polygon. If omitted, a boundary will be derived from
|
||
the .osm file, but borders will likely be broken or missing.</p>
|
||
</div><span id="variant.OneshotImport.field.drive_on_left" class="variant small-section-header"><a href="#variant.OneshotImport.field.drive_on_left" class="anchor field"></a><code>drive_on_left: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Do people drive on the left side of the road in this map?</p>
|
||
</div><span id="variant.OneshotImport.field.filter_crosswalks" class="variant small-section-header"><a href="#variant.OneshotImport.field.filter_crosswalks" class="anchor field"></a><code>filter_crosswalks: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Downgrade crosswalks not matching a <code>highway=crossing</code> OSM node into unmarked crossings.</p>
|
||
</div><span id="variant.OneshotImport.field.opts" class="variant small-section-header"><a href="#variant.OneshotImport.field.opts" class="anchor field"></a><code>opts: <a class="struct" href="../map_model/make/struct.RawToMapOptions.html" title="struct map_model::make::RawToMapOptions">RawToMapOptions</a></code></span></div></div><div id="variant.RegenerateEverything" class="variant small-section-header"><a href="#variant.RegenerateEverything" class="anchor field"></a><code>RegenerateEverything</code></div><div class="docblock"><p>Regenerate all maps and scenarios from scratch.</p>
|
||
</div><div class="sub-variant" id="variant.RegenerateEverything.fields"><h3>Fields of <b>RegenerateEverything</b></h3><div><span id="variant.RegenerateEverything.field.shard_num" class="variant small-section-header"><a href="#variant.RegenerateEverything.field.shard_num" class="anchor field"></a><code>shard_num: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a></code></span><div class="docblock"><p>If this command is being run in the cloud, parallelize the jobs by specifying which
|
||
shard this invocation should run.</p>
|
||
</div><span id="variant.RegenerateEverything.field.num_shards" class="variant small-section-header"><a href="#variant.RegenerateEverything.field.num_shards" class="anchor field"></a><code>num_shards: <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a></code></span><div class="docblock"><p>If this command is being run in the cloud, parallelize the jobs by specifying how many
|
||
total shards there are.</p>
|
||
</div></div></div><div id="variant.RegenerateAllMaps" class="variant small-section-header"><a href="#variant.RegenerateAllMaps" class="anchor field"></a><code>RegenerateAllMaps</code></div><div class="docblock"><p>Regenerate all maps from RawMaps in parallel.</p>
|
||
</div><div id="variant.Import" class="variant small-section-header"><a href="#variant.Import" class="anchor field"></a><code>Import</code></div><div class="docblock"><p>Import RawMaps, maps, scenarios, and city overviews for a single city.</p>
|
||
</div><div class="sub-variant" id="variant.Import.fields"><h3>Fields of <b>Import</b></h3><div><span id="variant.Import.field.job" class="variant small-section-header"><a href="#variant.Import.field.job" class="anchor field"></a><code>job: <a class="struct" href="../importer/struct.Job.html" title="struct importer::Job">Job</a></code></span></div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-StructOpt" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/cli/main.rs.html#21" title="goto source code">[src]</a></div><a href="#impl-StructOpt" class="anchor"></a><h3 class="code-header in-band">impl StructOpt for <a class="enum" href="enum.Command.html" title="enum cli::Command">Command</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clap" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/cli/main.rs.html#21" title="goto source code">[src]</a></div><a href="#method.clap" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clap</a><'a, 'b>() -> <a class="struct" href="https://docs.rs/clap/2.33.3/clap/app/struct.App.html" title="struct clap::app::App">App</a><'a, 'b></h4></div></summary><div class='docblock'><p>Returns <a href="https://docs.rs/clap/2.33.3/clap/app/struct.App.html" title="clap::App"><code>clap::App</code></a> corresponding to the struct.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_clap" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/cli/main.rs.html#21" title="goto source code">[src]</a></div><a href="#method.from_clap" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from_clap</a>(matches: &<a class="struct" href="https://docs.rs/clap/2.33.3/clap/args/arg_matches/struct.ArgMatches.html" title="struct clap::args::arg_matches::ArgMatches">ArgMatches</a><'_>) -> Self</h4></div></summary><div class='docblock'><p>Builds the struct from <a href="https://docs.rs/clap/2.33.3/clap/args/arg_matches/struct.ArgMatches.html" title="clap::ArgMatches"><code>clap::ArgMatches</code></a>. It’s guaranteed to succeed
|
||
if <code>matches</code> originates from an <code>App</code> generated by [<code>StructOpt::clap</code>] called on
|
||
the same type, otherwise it must panic. <a href="#tymethod.from_clap">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_args" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.from_args" class="anchor"></a><h4 class="code-header">fn <a href="#method.from_args" class="fnname">from_args</a>() -> Self</h4></div></summary><div class='docblock'><p>Builds the struct from the command line arguments (<a href="https://doc.rust-lang.org/1.56.1/std/env/fn.args_os.html" title="std::env::args_os"><code>std::env::args_os</code></a>).
|
||
Calls <a href="https://docs.rs/clap/2.33.3/clap/errors/struct.Error.html#method.exit" title="clap::Error::exit"><code>clap::Error::exit</code></a> on failure, printing the error message and aborting the program. <a href="#method.from_args">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_args_safe" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.from_args_safe" class="anchor"></a><h4 class="code-header">fn <a href="#method.from_args_safe" class="fnname">from_args_safe</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://docs.rs/clap/2.33.3/clap/errors/struct.Error.html" title="struct clap::errors::Error">Error</a>></h4></div></summary><div class='docblock'><p>Builds the struct from the command line arguments (<a href="https://doc.rust-lang.org/1.56.1/std/env/fn.args_os.html" title="std::env::args_os"><code>std::env::args_os</code></a>).
|
||
Unlike [<code>StructOpt::from_args</code>], returns <a href="https://docs.rs/clap/2.33.3/clap/errors/struct.Error.html" title="clap::Error"><code>clap::Error</code></a> on failure instead of aborting the program,
|
||
so calling <a href="https://docs.rs/clap/2.33.3/clap/errors/struct.Error.html#method.exit" title="clap::Error::exit"><code>.exit</code></a> is up to you. <a href="#method.from_args_safe">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_iter" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.from_iter" class="anchor"></a><h4 class="code-header">fn <a href="#method.from_iter" class="fnname">from_iter</a><I>(iter: I) -> Self <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> <I as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.56.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>>,<br> <I as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h4></div></summary><div class='docblock'><p>Gets the struct from any iterator such as a <code>Vec</code> of your making.
|
||
Print the error message and quit the program in case of failure. <a href="#method.from_iter">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from_iter_safe" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.from_iter_safe" class="anchor"></a><h4 class="code-header">fn <a href="#method.from_iter_safe" class="fnname">from_iter_safe</a><I>(iter: I) -> <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://docs.rs/clap/2.33.3/clap/errors/struct.Error.html" title="struct clap::errors::Error">Error</a>> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> <I as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/1.56.1/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a>>,<br> <I as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h4></div></summary><div class='docblock'><p>Gets the struct from any iterator such as a <code>Vec</code> of your making. <a href="#method.from_iter_safe">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-RefUnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-RefUnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.Command.html" title="enum cli::Command">Command</a></h3></div><div id="impl-Send" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Send" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="enum.Command.html" title="enum cli::Command">Command</a></h3></div><div id="impl-Sync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Sync" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="enum.Command.html" title="enum cli::Command">Command</a></h3></div><div id="impl-Unpin" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Unpin" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="enum.Command.html" title="enum cli::Command">Command</a></h3></div><div id="impl-UnwindSafe" class="impl has-srclink"><div class="rightside"></div><a href="#impl-UnwindSafe" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.Command.html" title="enum cli::Command">Command</a></h3></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Any" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/any.rs.html#132-136" title="goto source code">[src]</a></div><a href="#impl-Any" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/any.rs.html#133" title="goto source code">[src]</a></div><a href="#method.type_id" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.56.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></div><a href="#impl-Borrow%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#210" title="goto source code">[src]</a></div><a href="#method.borrow" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&</a>T</h4></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></div><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/borrow.rs.html#217" title="goto source code">[src]</a></div><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.56.1/std/primitive.reference.html">&mut </a>T</h4></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.56.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Downcast" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Downcast" class="anchor"></a><h3 class="code-header in-band">impl<T> Downcast for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_any" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.into_any" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">into_any</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T, <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>>) -> <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static, <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>></h4></div></summary><div class='docblock'><p>Convert <code>Box<dyn Trait></code> (where <code>Trait: Downcast</code>) to <code>Box<dyn Any></code>. <code>Box<dyn Any></code> can
|
||
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="#tymethod.into_any">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_any_rc" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.into_any_rc" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">into_any_rc</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static></h4></div></summary><div class='docblock'><p>Convert <code>Rc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Rc<Any></code>. <code>Rc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="#tymethod.into_any_rc">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_any" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.as_any" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">as_any</a>(&self) -> &(dyn <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</h4></div></summary><div class='docblock'><p>Convert <code>&Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&Any</code>’s vtable from <code>&Trait</code>’s. <a href="#tymethod.as_any">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_any_mut" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.as_any_mut" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">as_any_mut</a>(&mut self) -> &mut (dyn <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</h4></div></summary><div class='docblock'><p>Convert <code>&mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&mut Any</code>’s vtable from <code>&mut Trait</code>’s. <a href="#tymethod.as_any_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-DowncastSync" class="impl has-srclink"><div class="rightside"></div><a href="#impl-DowncastSync" class="anchor"></a><h3 class="code-header in-band">impl<T> DowncastSync for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_any_arc" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.into_any_arc" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">into_any_arc</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/1.56.1/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><dyn <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static></h4></div></summary><div class='docblock'><p>Convert <code>Arc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Arc<Any></code>. <code>Arc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="#tymethod.into_any_arc">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3CT%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#546-550" title="goto source code">[src]</a></div><a href="#impl-From%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#547" title="goto source code">[src]</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Instrument" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></div><a href="#impl-Instrument" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.instrument" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></div><a href="#method.instrument" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.26/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></div></summary><div class='docblock'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.in_current_span" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></div><a href="#method.in_current_span" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></div></summary><div class='docblock'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Into%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#535-542" title="goto source code">[src]</a></div><a href="#impl-Into%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#539" title="goto source code">[src]</a></div><a href="#method.into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-Same%3CT%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-Same%3CT%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> Same<T> for T</h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Output" class="type trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="type">Output</a> = T</h4></div></summary><div class='docblock'><p>Should always be <code>Self</code></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryFrom%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#583-592" title="goto source code">[src]</a></div><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error" class="type trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#589" title="goto source code">[src]</a></div><a href="#method.try_from" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-TryInto%3CU%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#569-578" title="goto source code">[src]</a></div><a href="#impl-TryInto%3CU%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Error-1" class="type trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.try_into" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#575" title="goto source code">[src]</a></div><a href="#method.try_into" class="anchor"></a><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-VZip%3CV%3E" class="impl has-srclink"><div class="rightside"></div><a href="#impl-VZip%3CV%3E" class="anchor"></a><h3 class="code-header in-band">impl<V, T> VZip<V> for T <span class="where fmt-newline">where<br> V: MultiLane<T>, </span></h3></div></summary><div class="impl-items"><div id="method.vzip" class="method trait-impl has-srclink"><div class="rightside"></div><a href="#method.vzip" class="anchor"></a><h4 class="code-header">pub fn <a class="fnname">vzip</a>(self) -> V</h4></div></div></details></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="cli" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||
<script src="../main.js"></script>
|
||
</body></html> |