<!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="A quad-tree to quickly find the closest points to some polylines."><metaname="keywords"content="rust, rustlang, rust-lang, FindClosest"><title>FindClosest in geom - 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 11]><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='../geom/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><h2class="location">Struct FindClosest</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><divclass="sidebar-links"><ahref="#structfield.geometries">geometries</a><ahref="#structfield.quadtree">quadtree</a></div><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.add">add</a><ahref="#method.all_close_pts">all_close_pts</a><ahref="#method.closest_pt">closest_pt</a><ahref="#method.new">new</a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><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><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><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-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2class="location">Other items in<br><ahref="index.html">geom</a></h2><divid="sidebar-vars"data-name="FindClosest"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"title="themes"><imgsrc="../brush.svg"width="18"height="18"alt="Pick another theme!"></button><divid="theme-choices"role="menu"></div></div><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"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"title="settings"><imgsrc="../wheel.svg"width="18"height="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class="fqn"><spanclass="in-band">Struct <ahref="index.html">geom</a>::<wbr><aclass="struct"href="#">FindClosest</a><buttonid="copy-path"onclick="copy_path(this)"title="copy path"><imgsrc="../clipboard.svg"width="19"height="18"alt="Copy item import"title="Copy item import to clipboard"></button></span><spanclass="out-of-band"><spanid="render-detail"><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span><aclass="srclink"href="../src/geom/find_closest.rs.html#13-17"title="goto source code">[src]</a></span></h1><divclass="docblock type-decl"><preclass="rust struct">pub struct FindClosest<K> {
}</pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A quad-tree to quickly find the closest points to some polylines.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.add"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.add"class="fnname">add</a>(&mut self, key: K, pts: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">&[</a><aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a><aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">]</a>)</h4><ahref="#method.add"class="anchor"></a><aclass="srclink"href="../src/geom/find_closest.rs.html#32-36"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Add an object to the quadtree, remembering some key associated with the points.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.all_close_pts"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.all_close_pts"class="fnname">all_close_pts</a>(<br> &self, <br> query_pt: <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <br> max_dist_away: <aclass="struct"href="distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><br>) -><aclass="struct"href="https://doc.rust-lang.org/1.54.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.tuple.html">(</a>K, <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <aclass="struct"href="distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.tuple.html">)</a>></h4><ahref="#method.all_close_pts"class="anchor"></a><aclass="srclink"href="../src/geom/find_closest.rs.html#40-78"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>For every object within some distance of a query point, return the (object’s key, point on
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.closest_pt"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.closest_pt"class="fnname">closest_pt</a>(<br> &self, <br> query_pt: <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <br> max_dist_away: <aclass="struct"href="distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><br>) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.tuple.html">(</a>K, <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a><aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.tuple.html">)</a>></h4><ahref="#method.closest_pt"class="anchor"></a><aclass="srclink"href="../src/geom/find_closest.rs.html#81-86"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Finds the closest point on the existing geometry to the query pt.</p>
</div></details></div></details><h2id="synthetic-implementations"class="small-section-header">Auto Trait Implementations<ahref="#synthetic-implementations"class="anchor"></a></h2><divid="synthetic-implementations-list"><divid="impl-RefUnwindSafe"class="impl has-srclink"><h3class="code-header in-band">impl<K><aclass="trait"href="https://doc.rust-lang.org/1.54.0/std/panic/trait.RefUnwindSafe.html"title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <aclass="struct"href="find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K><spanclass="where fmt-newline">where<br> K: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/std/panic/trait.RefUnwindSafe.html"title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></h3><ahref="#impl-RefUnwindSafe"class="anchor"></a></div><divid="impl-Send"class="impl has-srclink"><h3class="code-header in-band">impl<K><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K><spanclass="where fmt-newline">where<br> K: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a>, </span></h3><ahref="#impl-Send"class="anchor"></a></div><divid="impl-Sync"class="impl has-srclink"><h3class="code-header in-band">impl<K><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K><spanclass="where fmt-newline">where<br> K: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a>, </span></h3><ahref="#impl-Sync"class="anchor"></a></div><divid="impl-Unpin"class="impl has-srclink"><h3class="code-header in-band">impl<K><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Unpin.html"title="trait core::marker::Unpin">Unpin</a> for <aclass="struct"href="find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K><spanclass="where fmt-newline">where<br> K: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Unpin.html"title="trait core::marker::Unpin">Unpin</a>, </span></h3><ahref="#impl-Unpin"class="anchor"></a></div><divid="impl-UnwindSafe"class="impl has-srclink"><h3class="code-header in-band">impl<K><aclass="trait"href="https://doc.rust-lang.org/1.54.0/std/panic/trait.UnwindSafe.html"title="trait std::panic::UnwindSafe">UnwindSafe</a> for <aclass="struct"href="find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K><spanclass="where fmt-newline">where<br> K: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/std/panic/trait.RefUnwindSafe.html"title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> + <aclass="trait"href="https://doc.rust-lang.org/1.54.0/std/panic/trait.UnwindSafe.html"title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></h3><ahref="#impl-UnwindSafe"class="anchor"></a></div></div><h2id="blanket-implementations"class="small-section-header">Blanket Implementations<ahref="#blanket-implementations"class="anchor"></a></h2><divid="blanket-implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Any"class="impl has-srclink"><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T:
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Borrow%3CT%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></h3><ahref="#impl-Borrow%3CT%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#208-213"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.borrow"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html#tymethod.borrow"class="fnname">borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T</h4><ahref="#method.borrow"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#210"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-BorrowMut%3CT%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></h3><ahref="#impl-BorrowMut%3CT%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#216-220"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.borrow_mut"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut"class="fnname">borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&mut </a>T</h4><ahref="#method.borrow_mut"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#217"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Into%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></h3><ahref="#impl-Into%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#533-540"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html#tymethod.into"class="fnname">into</a>(self) -> U</h4><ahref="#method.into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#537"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Same%3CT%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T> Same<T> for T</h3><ahref="#impl-Same%3CT%3E"class="anchor"></a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Output"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="#associatedtype.Output"class="type">Output</a> = T</h4><ahref="#associatedtype.Output"class="anchor"></a></div></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/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/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#581-590"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4><ahref="#associatedtype.Error"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_from"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#587"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/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/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#567-576"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error-1"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4><ahref="#associatedtype.Error-1"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#573"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
