<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">☰</div><ahref='../../map_model/index.html'><divclass='logo-container rust-logo'><imgsrc='../../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct Path</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#fields">Fields</a><divclass="sidebar-links"><ahref="#structfield.crossed_so_far">crossed_so_far</a><ahref="#structfield.currently_inside_ut">currently_inside_ut</a><ahref="#structfield.orig_req">orig_req</a><ahref="#structfield.steps">steps</a><ahref="#structfield.total_length">total_length</a><ahref="#structfield.uber_turns">uber_turns</a></div><aclass="sidebar-title"href="#implementations">Methods</a><divclass="sidebar-links"><ahref="#method.about_to_start_ut">about_to_start_ut</a><ahref="#method.add">add</a><ahref="#method.append">append</a><ahref="#method.crossed_so_far">crossed_so_far</a><ahref="#method.current_step">current_step</a><ahref="#method.currently_inside_ut">currently_inside_ut</a><ahref="#method.dist_crossed_from_step">dist_crossed_from_step</a><ahref="#method.estimate_duration">estimate_duration</a><ahref="#method.get_req">get_req</a><ahref="#method.get_steps">get_steps</a><ahref="#method.is_empty">is_empty</a><ahref="#method.is_last_step">is_last_step</a><ahref="#method.is_upcoming_uber_turn_component">is_upcoming_uber_turn_component</a><ahref="#method.isnt_last_step">isnt_last_step</a><ahref="#method.last_step">last_step</a><ahref="#method.maybe_next_step">maybe_next_step</a><ahref="#method.modify_step">modify_step</a><ahref="#method.new">new</a><ahref="#method.next_step">next_step</a><ahref="#method.one_step">one_step</a><ahref="#method.percent_dist_crossed">percent_dist_crossed</a><ahref="#method.shift">shift</a><ahref="#method.total_length">total_length</a><ahref="#method.trace">trace</a></div><aclass="sidebar-title"href="#trait-implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Debug">Debug</a><ahref="#impl-Deserialize%3C%27de%3E">Deserialize<'de></a><ahref="#impl-PartialEq%3CPath%3E">PartialEq<Path></a><ahref="#impl-Serialize">Serialize</a><ahref="#impl-StructuralPartialEq">StructuralPartialEq</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-From%3CT%3E">From<T></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_model</a>::<wbr><ahref='index.html'>pathfind</a></p><script>window.sidebarCurrent={name:'Path',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form"><divclass="search-container"><div><s
beginning or end of our path, then the full length may not be used.</p>
</div><h4id='method.one_step'class="method"><code>pub fn <ahref='#method.one_step'class='fnname'>one_step</a>(req: <aclass="struct"href="../../map_model/struct.PathRequest.html"title="struct map_model::PathRequest">PathRequest</a>, map: &<aclass="struct"href="../../map_model/struct.Map.html"title="struct map_model::Map">Map</a>) -><aclass="struct"href="../../map_model/struct.Path.html"title="struct map_model::Path">Path</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#176-179'title='goto source code'>[src]</a></h4><h4id='method.get_req'class="method"><code>pub fn <ahref='#method.get_req'class='fnname'>get_req</a>(&self) ->&<aclass="struct"href="../../map_model/struct.PathRequest.html"title="struct map_model::PathRequest">PathRequest</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#183-185'title='goto source code'>[src]</a></h4><divclass='docblock'><p>The original PathRequest used to produce this path. If the path has been modified since
</div><h4id='method.current_step'class="method"><code>pub fn <ahref='#method.current_step'class='fnname'>current_step</a>(&self) -><aclass="enum"href="../../map_model/enum.PathStep.html"title="enum map_model::PathStep">PathStep</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#305-307'title='goto source code'>[src]</a></h4><h4id='method.next_step'class="method"><code>pub fn <ahref='#method.next_step'class='fnname'>next_step</a>(&self) -><aclass="enum"href="../../map_model/enum.PathStep.html"title="enum map_model::PathStep">PathStep</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#309-311'title='goto source code'>[src]</a></h4><h4id='method.maybe_next_step'class="method"><code>pub fn <ahref='#method.maybe_next_step'class='fnname'>maybe_next_step</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="enum"href="../../map_model/enum.PathStep.html"title="enum map_model::PathStep">PathStep</a>></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#312-318'title='goto source code'>[src]</a></h4><h4id='method.last_step'class="method"><code>pub fn <ahref='#method.last_step'class='fnname'>last_step</a>(&self) -><aclass="enum"href="../../map_model/enum.PathStep.html"title="enum map_model::PathStep">PathStep</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#320-322'title='goto source code'>[src]</a></h4><h4id='method.trace'class="method"><code>pub fn <ahref='#method.trace'class='fnname'>trace</a>(&self, map: &<aclass="struct"href="../../map_model/struct.Map.html"title="struct map_model::Map">Map</a>, start_dist: <aclass="struct"href="../../geom/distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../geom/polyline/struct.PolyLine.html"title="struct geom::polyline::PolyLine">PolyLine</a>></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#325-388'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Traces along the path from a specified distance along the first step until the end.</p>
</div><h4id='method.get_steps'class="method"><code>pub fn <ahref='#method.get_steps'class='fnname'>get_steps</a>(&self) ->&<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/collections/vec_deque/struct.VecDeque.html"title="struct alloc::collections::vec_deque::VecDeque">VecDeque</a><<aclass="enum"href="../../map_model/enum.PathStep.html"title="enum map_model::PathStep">PathStep</a>></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#390-392'title='goto source code'>[src]</a></h4><h4id='method.append'class="method"><code>fn <ahref='#method.append'class='fnname'>append</a>(&mut self, other: <aclass="struct"href="../../map_model/struct.Path.html"title="struct map_model::Path">Path</a>, map: &<aclass="struct"href="../../map_model/struct.Map.html"title="struct map_model::Map">Map</a>)</code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#395-412'title='goto source code'>[src]</a></h4><h4id='method.estimate_duration'class="method"><code>pub fn <ahref='#method.estimate_duration'class='fnname'>estimate_duration</a>(<br> &self, <br> map: &<aclass="struct"href="../../map_model/struct.Map.html"title="struct map_model::Map">Map</a>, <br> constraints: <aclass="enum"href="../../map_model/enum.PathConstraints.html"title="enum map_model::PathConstraints">PathConstraints</a>, <br> max_speed: <aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="../../geom/speed/struct.Speed.html"title="struct geom::speed::Speed">Speed</a>><br>) -><aclass="struct"href="../../geom/duration/struct.Duration.html"title="struct geom::duration::Duration">Duration</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#417-439'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Estimate how long following the path will take in the best case, assuming no traffic or
</div></div><h3id='impl-Debug'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="struct"href="../../map_model/struct.Path.html"title="struct map_model::Path">Path</a></code><ahref='#impl-Debug'class='anchor'></a><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.fmt'class="method hidden"><code>fn <ahref='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt'class='fnname'>fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a><'_>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#102'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></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.118/serde/de/trait.Deserialize.html"title="trait serde::de::Deserialize">Deserialize</a><'de> for <aclass="struct"href="../../map_model/struct.Path.html"title="struct map_model::Path">Path</a></code><ahref='#impl-Deserialize%3C%27de%3E'class='anchor'></a><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#102'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.118/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.118/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.118/serde/de/trait.Deserializer.html"title="trait serde::de::Deserializer">Deserializer</a><'de>, </span></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#102'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.118/serde/de/trait.Deserialize.html#tymethod.deserialize">Read more</a></p>
</div></div><h3id='impl-PartialEq%3CPath%3E'class='impl'><codeclass='in-band'>impl <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html"title="trait core::cmp::PartialEq">PartialEq</a><<aclass="struct"href="../../map_model/struct.Path.html"title="struct map_model::Path">Path</a>> for <aclass="struct"href="../../map_model/struct.Path.html"title="struct map_model::Path">Path</a></code><ahref='#impl-PartialEq%3CPath%3E'class='anchor'></a><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.eq'class="method hidden"><code>fn <ahref='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq'class='fnname'>eq</a>(&self, other: &<aclass="struct"href="../../map_model/struct.Path.html"title="struct map_model::Path">Path</a>) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><aclass='srclink'href='../../src/map_model/pathfind/mod.rs.html#102'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
</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#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#588-597'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#594-596'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#574-583'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#580-582'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
