<!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="API documentation for the Rust `Sim` struct in crate `sim`."><metaname="keywords"content="rust, rustlang, rust-lang, Sim"><title>sim::Sim - 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><scriptsrc="../storage.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="shortcut icon"href="../favicon.ico"><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">☰</div><ahref='../sim/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct Sim</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#fields">Fields</a><divclass="sidebar-links"><ahref="#structfield.alerts">alerts</a><ahref="#structfield.analytics">analytics</a><ahref="#structfield.cap">cap</a><ahref="#structfield.driving">driving</a><ahref="#structfield.edits_name">edits_name</a><ahref="#structfield.intersections">intersections</a><ahref="#structfield.map_name">map_name</a><ahref="#structfield.pandemic">pandemic</a><ahref="#structfield.parking">parking</a><ahref="#structfield.run_name">run_name</a><ahref="#structfield.scheduler">scheduler</a><ahref="#structfield.step_count">step_count</a><ahref="#structfield.time">time</a><ahref="#structfield.transit">transit</a><ahref="#structfield.trips">trips</a><ahref="#structfield.walking">walking</a></div><aclass="sidebar-title"href="#implementations">Methods</a><divclass="sidebar-links"><ahref="#method.active_agents">active_agents</a><ahref="#method.agent_properties">agent_properties</a><ahref="#method.agent_to_person">agent_to_person</a><ahref="#method.agent_to_trip">agent_to_trip</a><ahref="#method.all_arrivals_at_border">all_arrivals_at_border</a><ahref="#method.all_parked_car_positions">all_parked_car_positions</a><ahref="#method.all_trip_info">all_trip_info</a><ahref="#method.all_waiting_people">all_waiting_people</a><ahref="#method.bldg_to_parked_cars">bldg_to_parked_cars</a><ahref="#method.bldg_to_people">bldg_to_people</a><ahref="#method.bus_route_id">bus_route_id</a><ahref="#method.canonical_pt_for_agent">canonical_pt_for_agent</a><ahref="#method.clear_alerts">clear_alerts</a><ahref="#method.current_stage_and_remaining_time">current_stage_and_remaining_time</a><ahref="#method.debug_car">debug_car</a><ahref="#method.debug_intersection">debug_intersection</a><ahref="#method.debug_lane">debug_lane</a><ahref="#method.debug_ped">debug_ped</a><ahref="#method.delayed_intersections">delayed_intersections</a><ahref="#method.delete_car">delete_car</a><ahref="#method.describe_scheduler_stats">describe_scheduler_stats</a><ahref="#method.dispatch_events">dispatch_events</a><ahref="#method.do_step">do_step</a><ahref="#method.dump_before_abort">dump_before_abort</a><ahref="#method.find_blockage_front">find_blockage_front</a><ahref="#method.find_next_savestate">find_next_savestate</a><ahref="#method.find_person_by_orig_id">find_person_by_orig_id</a><ahref="#method.find_previous_savestate">find_previous_savestate</a><ahref="#method.find_trips_affected_by_live_edits">find_trips_affected_by_live_edits</a><ahref="#method.finished_trip_time">finished_trip_time</a><ahref="#method.flush_spawner">flush_spawner</a><ahref="#method.generate_scenario">generate_scenario</a><ahref="#method.get
</div><h4id='method.num_agents'class="method"><code>pub fn <ahref='#method.num_agents'class='fnname'>num_agents</a>(&self) -><aclass="struct"href="../abstutil/collections/struct.Counter.html"title="struct abstutil::collections::Counter">Counter</a><<aclass="enum"href="../sim/enum.AgentType.html"title="enum sim::AgentType">AgentType</a>></code><aclass='srclink'href='../src/sim/sim/queries.rs.html#37-39'title='goto source code'>[src]</a></h4><h4id='method.num_commuters_vehicles'class="method"><code>pub fn <ahref='#method.num_commuters_vehicles'class='fnname'>num_commuters_vehicles</a>(&self) -><aclass="struct"href="../sim/struct.CommutersVehiclesCounts.html"title="struct sim::CommutersVehiclesCounts">CommutersVehiclesCounts</a></code><aclass='srclink'href='../src/sim/sim/queries.rs.html#40-43'title='goto source code'>[src]</a></h4><h4id='method.num_ppl'class="method"><code>pub fn <ahref='#method.num_ppl'class='fnname'>num_ppl</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><aclass='srclink'href='../src/sim/sim/queries.rs.html#45-47'title='goto source code'>[src]</a></h4><divclass='docblock'><p>(total number of people, just in buildings, just off map)</p>
</div><h4id='method.bldg_to_parked_cars'class="method"><code>pub fn <ahref='#method.bldg_to_parked_cars'class='fnname'>bldg_to_parked_cars</a>(&self, b: <aclass="struct"href="../map_model/objects/building/struct.BuildingID.html"title="struct map_model::objects::building::BuildingID">BuildingID</a>) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="../sim/struct.CarID.html"title="struct sim::CarID">CarID</a>></code><aclass='srclink'href='../src/sim/sim/mod.rs.html#248-250'title='goto source code'>[src]</a></h4><h4id='method.walking_path_to_nearest_parking_spot'class="method"><code>pub fn <ahref='#method.walking_path_to_nearest_parking_spot'class='fnname'>walking_path_to_nearest_parking_spot</a>(<br> &self, <br> map: &<aclass="struct"href="../map_model/struct.Map.html"title="struct map_model::Map">Map</a>, <br> b: <aclass="struct"href="../map_model/objects/building/struct.BuildingID.html"title="struct map_model::objects::building::BuildingID">BuildingID</a><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><aclass="struct"href="../map_model/pathfind/struct.Path.html"title="struct map_model::pathfind::Path">Path</a>, <aclass="struct"href="../geom/distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><aclass='srclink'href='../src/sim/sim/mod.rs.html#253-291'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Also returns the start distance of the building. TODO Do that in the Path properly.</p>
</div></div><h3id='impl-Deserialize%3C%27de%3E'class='impl'><codeclass='in-band'>impl<'de><aclass="trait"href="https://docs.rs/serde/1.0.116/serde/de/trait.Deserialize.html"title="trait serde::de::Deserialize">Deserialize</a><'de> for <aclass="struct"href="../sim/struct.Sim.html"title="struct sim::Sim">Sim</a></code><ahref='#impl-Deserialize%3C%27de%3E'class='anchor'></a><aclass='srclink'href='../src/sim/sim/mod.rs.html#33'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.116/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.116/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.116/serde/de/trait.Deserializer.html"title="trait serde::de::Deserializer">Deserializer</a><'de>, </span></code><aclass='srclink'href='../src/sim/sim/mod.rs.html#33'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.116/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.116/serde/ser/trait.Serialize.html"title="trait serde::ser::Serialize">Serialize</a> for <aclass="struct"href="../sim/struct.Sim.html"title="struct sim::Sim">Sim</a></code><ahref='#impl-Serialize'class='anchor'></a><aclass='srclink'href='../src/sim/sim/mod.rs.html#33'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.116/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.116/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.116/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.116/serde/ser/trait.Serializer.html"title="trait serde::ser::Serializer">Serializer</a>, </span></code><aclass='srclink'href='../src/sim/sim/mod.rs.html#33'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.116/serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></p>
</div></div><h3id='impl-DeserializeOwned'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://docs.rs/serde/1.0.116/serde/de/trait.DeserializeOwned.html"title="trait serde::de::DeserializeOwned">DeserializeOwned</a> for T <spanclass="where fmt-newline">where<br> T: for<'de><aclass="trait"href="https://docs.rs/serde/1.0.116/serde/de/trait.Deserialize.html"title="trait serde::de::Deserialize">Deserialize</a><'de>, </span></code><ahref='#impl-DeserializeOwned'class='anchor'></a><aclass='srclink'href='https://docs.rs/serde/1.0.116/src/serde/de/mod.rs.html#604'title='goto source code'>[src]</a></h3><divclass='impl-items'></div><h3id='impl-Downcast'class='impl'><codeclass='in-band'>impl<T> Downcast for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a>, </span></code><ahref='#impl-Downcast'class='anchor'></a></h3><divclass='impl-items'><h4id='method.into_any'class="method hidden"><code>fn <ahref='#method.into_any'class='fnname'>into_any</a>(self: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html"title="struct alloc::boxed::Box">Box</a><T>) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html"title="struct alloc::boxed::Box">Box</a><dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static></code></h4><divclass='docblock hidden'><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>. <ahref="#tymethod.into_any">Read more</a></p>
</div><h4id='method.into_any_rc'class="method hidden"><code>fn <ahref='#method.into_any_rc'class='fnname'>into_any_rc</a>(self: <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html"title="struct alloc::rc::Rc">Rc</a><T>) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html"title="struct alloc::rc::Rc">Rc</a><dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static></code></h4><divclass='docblock hidden'><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>. <ahref="#tymethod.into_any_rc">Read more</a></p>
</div><h4id='method.as_any'class="method hidden"><code>fn <ahref='#method.as_any'class='fnname'>as_any</a>(&self) ->&(dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static)</code></h4><divclass='docblock hidden'><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. <ahref="#tymethod.as_any">Read more</a></p>
</div><h4id='method.as_any_mut'class="method hidden"><code>fn <ahref='#method.as_any_mut'class='fnname'>as_any_mut</a>(&mut self) ->&mut (dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> + 'static)</code></h4><divclass='docblock hidden'><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. <ahref="#tymethod.as_any_mut">Read more</a></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#80-92'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>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#85-87'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>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#89-91'title='goto source code'>[src]</a></h4><divclass='stability 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#607-616'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>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#613-615'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#593-602'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>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#599-601'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
