<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Options controlling the UI. Some of the options are common to all map-based apps, and some are specific to A/B Street."><metaname="keywords"content="rust, rustlang, rust-lang, Options"><title>map_gui::options::Options - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../../ayu.css"disabled><scriptid="default-settings"></script><scriptsrc="../../storage.js"></script><scriptsrc="../../crates.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="icon"type="image/svg+xml"href="../../favicon.svg">
<linkrel="alternate icon"type="image/png"href="../../favicon-32x32.png"><styletype="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu"role="button">☰</div><ahref='../../map_gui/index.html'><divclass='logo-container rust-logo'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass="location">Struct Options</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#fields">Fields</a><divclass="sidebar-links"><ahref="#structfield.camera_angle">camera_angle</a><ahref="#structfield.canvas_settings">canvas_settings</a><ahref="#structfield.color_scheme">color_scheme</a><ahref="#structfield.debug_all_agents">debug_all_agents</a><ahref="#structfield.dev">dev</a><ahref="#structfield.dont_draw_time_warp">dont_draw_time_warp</a><ahref="#structfield.jump_to_delay">jump_to_delay</a><ahref="#structfield.language">language</a><ahref="#structfield.min_zoom_for_detail">min_zoom_for_detail</a><ahref="#structfield.minimal_controls">minimal_controls</a><ahref="#structfield.time_increment">time_increment</a><ahref="#structfield.toggle_day_night_colors">toggle_day_night_colors</a><ahref="#structfield.traffic_signal_style">traffic_signal_style</a><ahref="#structfield.units">units</a></div><aclass="sidebar-title"href="#implementations">Methods</a><divclass="sidebar-links"><ahref="#method.load_or_default">load_or_default</a><ahref="#method.update_from_args">update_from_args</a></div><aclass="sidebar-title"href="#trait-implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Deserialize%3C%27de%3E">Deserialize<'de></a><ahref="#impl-Serialize">Serialize</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-DeserializeOwned">DeserializeOwned</a><ahref="#impl-Downcast">Downcast</a><ahref="#impl-DowncastSync">DowncastSync</a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Instrument">Instrument</a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-ToOwned">ToOwned</a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a><ahref="#impl-VZip%3CV%3E">VZip<V></a></div></div><pclass="location"><ahref="../index.html">map_gui</a>::<wbr><ahref="index.html">options</a></p><divid="sidebar-vars"data-name="Options"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"><imgsrc="../../brush.svg"width="18"height="18"alt="Pick another theme!"></button><divid="theme-choices"role="menu"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><buttontype="button"class="help-button">?</button>
</div><spanid="structfield.debug_all_agents"class="structfield small-section-header"><ahref="#structfield.debug_all_agents"class="anchor field"></a><code>debug_all_agents: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><divclass="docblock"><p>Every time we draw, render all agents zoomed in. Extremely slow. Just used to flush out
</div><spanid="structfield.traffic_signal_style"class="structfield small-section-header"><ahref="#structfield.traffic_signal_style"class="anchor field"></a><code>traffic_signal_style: <aclass="enum"href="../../map_gui/options/enum.TrafficSignalStyle.html"title="enum map_gui::options::TrafficSignalStyle">TrafficSignalStyle</a></code></span><divclass="docblock"><p>How traffic signals should be rendered.</p>
</div><spanid="structfield.color_scheme"class="structfield small-section-header"><ahref="#structfield.color_scheme"class="anchor field"></a><code>color_scheme: <aclass="enum"href="../../map_gui/colors/enum.ColorSchemeChoice.html"title="enum map_gui::colors::ColorSchemeChoice">ColorSchemeChoice</a></code></span><divclass="docblock"><p>The color scheme for map elements, agents, and the UI.</p>
</div><spanid="structfield.toggle_day_night_colors"class="structfield small-section-header"><ahref="#structfield.toggle_day_night_colors"class="anchor field"></a><code>toggle_day_night_colors: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><divclass="docblock"><p>Automatically change color_scheme based on simulation time to reflect day/night</p>
</div><spanid="structfield.min_zoom_for_detail"class="structfield small-section-header"><ahref="#structfield.min_zoom_for_detail"class="anchor field"></a><code>min_zoom_for_detail: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></span><divclass="docblock"><p>Map elements are drawn differently when unzoomed and zoomed. This specifies the canvas zoom
</div><spanid="structfield.camera_angle"class="structfield small-section-header"><ahref="#structfield.camera_angle"class="anchor field"></a><code>camera_angle: <aclass="enum"href="../../map_gui/options/enum.CameraAngle.html"title="enum map_gui::options::CameraAngle">CameraAngle</a></code></span><divclass="docblock"><p>Draw buildings in different perspectives</p>
</div><spanid="structfield.minimal_controls"class="structfield small-section-header"><ahref="#structfield.minimal_controls"class="anchor field"></a><code>minimal_controls: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><divclass="docblock"><p>When making a screen recording, enable this option to hide some UI elements</p>
</div><spanid="structfield.time_increment"class="structfield small-section-header"><ahref="#structfield.time_increment"class="anchor field"></a><code>time_increment: <aclass="struct"href="../../geom/duration/struct.Duration.html"title="struct geom::duration::Duration">Duration</a></code></span><divclass="docblock"><p>How much to advance the sim with one of the speed controls</p>
</div><spanid="structfield.dont_draw_time_warp"class="structfield small-section-header"><ahref="#structfield.dont_draw_time_warp"class="anchor field"></a><code>dont_draw_time_warp: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><divclass="docblock"><p>When time warping, don’t draw to speed up simulation</p>
</div><spanid="structfield.jump_to_delay"class="structfield small-section-header"><ahref="#structfield.jump_to_delay"class="anchor field"></a><code>jump_to_delay: <aclass="struct"href="../../geom/duration/struct.Duration.html"title="struct geom::duration::Duration">Duration</a></code></span><divclass="docblock"><p>The delay threshold to halt on when jumping to the next delay</p>
</div><spanid="structfield.language"class="structfield small-section-header"><ahref="#structfield.language"class="anchor field"></a><code>language: <aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>></code></span><divclass="docblock"><p>Display roads and buildings in an alternate language, if possible. None means to use the
</div><h2id="implementations"class="small-section-header">Implementations<ahref="#implementations"class="anchor"></a></h2><h3id="impl"class="impl"><codeclass="in-band">impl <aclass="struct"href="../../map_gui/options/struct.Options.html"title="struct map_gui::options::Options">Options</a></code><ahref="#impl"class="anchor"></a><aclass="srclink"href="../../src/map_gui/options.rs.html#58-126"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="method.load_or_default"class="method"><code>pub fn <ahref="#method.load_or_default"class="fnname">load_or_default</a>() -><aclass="struct"href="../../map_gui/options/struct.Options.html"title="struct map_gui::options::Options">Options</a></code><aclass="srclink"href="../../src/map_gui/options.rs.html#61-97"title="goto source code">[src]</a></h4><divclass="docblock"><p>Restore previous options. If the file is missing or the format has changed, fall back to
</div></div><h3id="impl-Deserialize%3C%27de%3E"class="impl"><codeclass="in-band">impl<'de><aclass="trait"href="https://docs.rs/serde/1.0.126/serde/de/trait.Deserialize.html"title="trait serde::de::Deserialize">Deserialize</a><'de> for <aclass="struct"href="../../map_gui/options/struct.Options.html"title="struct map_gui::options::Options">Options</a></code><ahref="#impl-Deserialize%3C%27de%3E"class="anchor"></a><aclass="srclink"href="../../src/map_gui/options.rs.html#18"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="method.deserialize"class="method hidden"><code>fn <ahref="https://docs.rs/serde/1.0.126/serde/de/trait.Deserialize.html#tymethod.deserialize"class="fnname">deserialize</a><__D>(__deserializer: __D) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self, __D::<aclass="type"href="https://docs.rs/serde/1.0.126/serde/de/trait.Deserializer.html#associatedtype.Error"title="type serde::de::Deserializer::Error">Error</a>><spanclass="where fmt-newline">where<br> __D: <aclass="trait"href="https://docs.rs/serde/1.0.126/serde/de/trait.Deserializer.html"title="trait serde::de::Deserializer">Deserializer</a><'de>, </span></code><aclass="srclink"href="../../src/map_gui/options.rs.html#18"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Deserialize this value from the given Serde deserializer. <ahref="https://docs.rs/serde/1.0.126/serde/de/trait.Deserialize.html#tymethod.deserialize">Read more</a></p>
</div></div><h3id="impl-Serialize"class="impl"><codeclass="in-band">impl <aclass="trait"href="https://docs.rs/serde/1.0.126/serde/ser/trait.Serialize.html"title="trait serde::ser::Serialize">Serialize</a> for <aclass="struct"href="../../map_gui/options/struct.Options.html"title="struct map_gui::options::Options">Options</a></code><ahref="#impl-Serialize"class="anchor"></a><aclass="srclink"href="../../src/map_gui/options.rs.html#18"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="method.serialize"class="method hidden"><code>fn <ahref="https://docs.rs/serde/1.0.126/serde/ser/trait.Serialize.html#tymethod.serialize"class="fnname">serialize</a><__S>(&self, __serializer: __S) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><__S::<aclass="type"href="https://docs.rs/serde/1.0.126/serde/ser/trait.Serializer.html#associatedtype.Ok"title="type serde::ser::Serializer::Ok">Ok</a>, __S::<aclass="type"href="https://docs.rs/serde/1.0.126/serde/ser/trait.Serializer.html#associatedtype.Error"title="type serde::ser::Serializer::Error">Error</a>><spanclass="where fmt-newline">where<br> __S: <aclass="trait"href="https://docs.rs/serde/1.0.126/serde/ser/trait.Serializer.html"title="trait serde::ser::Serializer">Serializer</a>, </span></code><aclass="srclink"href="../../src/map_gui/options.rs.html#18"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Serialize this value into the given Serde serializer. <ahref="https://docs.rs/serde/1.0.126/serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></p>
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any">Read more</a></p>
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_rc">Read more</a></p>
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_arc">Read more</a></p>
</div></div><h3id="impl-Instrument"class="impl"><codeclass="in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</code><ahref="#impl-Instrument"class="anchor"></a><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#155"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="method.instrument"class="method hidden"><code>pub fn <ahref="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#38"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
</div><h4id="method.in_current_span"class="method hidden"><code>pub fn <ahref="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fnname">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#74"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the <ahref="../struct.Span.html#method.current">current</a><code>Span</code>, returning an
</div></div><h3id="impl-Same%3CT%3E"class="impl"><codeclass="in-band">impl<T> Same<T> for T</code><ahref="#impl-Same%3CT%3E"class="anchor"></a></h3><divclass="impl-items"><h4id="associatedtype.Output"class="type"><code>type <ahref="#associatedtype.Output"class="type">Output</a> = T</code></h4><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3id="impl-ToOwned"class="impl"><codeclass="in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></code><ahref="#impl-ToOwned"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-93"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="associatedtype.Owned"class="type"><code>type <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="type">Owned</a> = T</code></h4><divclass='docblock'><p>The resulting type after obtaining ownership.</p>
</div><h4id="method.to_owned"class="method hidden"><code>pub fn <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fnname">to_owned</a>(&self) -> T</code><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#86"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div><h4id="method.clone_into"class="method hidden"><code>pub fn <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fnname">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#90"title="goto source code">[src]</a></h4><divclass="item-info hidden"><divclass="stab unstable"><details><summary><spanclass="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><divclass='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></div><h3id="impl-TryFrom%3CU%3E"class="impl"><codeclass="in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#581-590"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="associatedtype.Error"class="type"><code>type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id="method.try_from"class="method hidden"><code>pub fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#587"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id="impl-TryInto%3CU%3E"class="impl"><codeclass="in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#567-576"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="associatedtype.Error-1"class="type"><code>type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id="method.try_into"class="method hidden"><code>pub fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#573"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id="impl-VZip%3CV%3E"class="impl"><codeclass="in-band">impl<V, T> VZip<V> for T <spanclass="where fmt-newline">where<br> V: MultiLane<T>, </span></code><ahref="#impl-VZip%3CV%3E"class="anchor"></a></h3><divclass="impl-items"><h4id="method.vzip"class="method hidden"><code>pub fn <ahref="#method.vzip"class="fnname">vzip</a>(self) -> V</code></h4></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><divid="rustdoc-vars"data-root-path="../../"data-current-crate="map_gui"data-search-js="../../search-index.js"></div>
