<!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="Source to the Rust file `src/liballoc/collections/btree/search.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>search.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../../../normalize1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../../rustdoc1.35.0.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../../dark1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../../light1.35.0.css" id="themeStyle"><script src="../../../../storage1.35.0.js"></script><noscript><link rel="stylesheet" href="../../../../noscript1.35.0.css"></noscript><link rel="shortcut icon" href="../../../../favicon1.35.0.ico"><style type="text/css">#crate-search{background-image:url("../../../../down-arrow1.35.0.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../../alloc/index.html'><img src='../../../../rust-logo1.35.0.png' alt='logo' width='100'></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../../brush1.35.0.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../../theme1.35.0.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../../settings.html"><img src="../../../../wheel1.35.0.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10">10</span> <span id="11">11</span> <span id="12">12</span> <span id="13">13</span> <span id="14">14</span> <span id="15">15</span> <span id="16">16</span> <span id="17">17</span> <span id="18">18</span> <span id="19">19</span> <span id="20">20</span> <span id="21">21</span> <span id="22">22</span> <span id="23">23</span> <span id="24">24</span> <span id="25">25</span> <span id="26">26</span> <span id="27">27</span> <span id="28">28</span> <span id="29">29</span> <span id="30">30</span> <span id="31">31</span> <span id="32">32</span> <span id="33">33</span> <span id="34">34</span> <span id="35">35</span> <span id="36">36</span> <span id="37">37</span> <span id="38">38</span> <span id="39">39</span> <span id="40">40</span> <span id="41">41</span> <span id="42">42</span> <span id="43">43</span> <span id="44">44</span> <span id="45">45</span> <span id="46">46</span> <span id="47">47</span> <span id="48">48</span> <span id="49">49</span> <span id="50">50</span> <span id="51">51</span> <span id="52">52</span> <span id="53">53</span> <span id="54">54</span> <span id="55">55</span> <span id="56">56</span> <span id="57">57</span> <span id="58">58</span> <span id="59">59</span> <span id="60">60</span> <span id="61">61</span> <span id="62">62</span> <span id="63">63</span> </pre><div class="example-wrap"><pre class="rust "> <span class="kw">use</span> <span class="ident">core</span>::<span class="ident">borrow</span>::<span class="ident">Borrow</span>; <span class="kw">use</span> <span class="ident">core</span>::<span class="ident">cmp</span>::<span class="ident">Ordering</span>; <span class="kw">use</span> <span class="kw">super</span>::<span class="ident">node</span>::{<span class="ident">Handle</span>, <span class="ident">NodeRef</span>, <span class="ident">marker</span>, <span class="ident">ForceResult</span>::<span class="kw-2">*</span>}; <span class="kw">use</span> <span class="ident">SearchResult</span>::<span class="kw-2">*</span>; <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">SearchResult</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">FoundType</span>, <span class="ident">GoDownType</span><span class="op">></span> { <span class="ident">Found</span>(<span class="ident">Handle</span><span class="op"><</span><span class="ident">NodeRef</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">FoundType</span><span class="op">></span>, <span class="ident">marker</span>::<span class="ident">KV</span><span class="op">></span>), <span class="ident">GoDown</span>(<span class="ident">Handle</span><span class="op"><</span><span class="ident">NodeRef</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">GoDownType</span><span class="op">></span>, <span class="ident">marker</span>::<span class="ident">Edge</span><span class="op">></span>) } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">search_tree</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">Q</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span>( <span class="kw-2">mut</span> <span class="ident">node</span>: <span class="ident">NodeRef</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">marker</span>::<span class="ident">LeafOrInternal</span><span class="op">></span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">Q</span> ) <span class="op">-></span> <span class="ident">SearchResult</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">marker</span>::<span class="ident">LeafOrInternal</span>, <span class="ident">marker</span>::<span class="ident">Leaf</span><span class="op">></span> <span class="kw">where</span> <span class="ident">Q</span>: <span class="ident">Ord</span>, <span class="ident">K</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Q</span><span class="op">></span> { <span class="kw">loop</span> { <span class="kw">match</span> <span class="ident">search_node</span>(<span class="ident">node</span>, <span class="ident">key</span>) { <span class="ident">Found</span>(<span class="ident">handle</span>) <span class="op">=></span> <span class="kw">return</span> <span class="ident">Found</span>(<span class="ident">handle</span>), <span class="ident">GoDown</span>(<span class="ident">handle</span>) <span class="op">=></span> <span class="kw">match</span> <span class="ident">handle</span>.<span class="ident">force</span>() { <span class="ident">Leaf</span>(<span class="ident">leaf</span>) <span class="op">=></span> <span class="kw">return</span> <span class="ident">GoDown</span>(<span class="ident">leaf</span>), <span class="ident">Internal</span>(<span class="ident">internal</span>) <span class="op">=></span> { <span class="ident">node</span> <span class="op">=</span> <span class="ident">internal</span>.<span class="ident">descend</span>(); <span class="kw">continue</span>; } } } } } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">search_node</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">Type</span>, <span class="ident">Q</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span>( <span class="ident">node</span>: <span class="ident">NodeRef</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">Type</span><span class="op">></span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">Q</span> ) <span class="op">-></span> <span class="ident">SearchResult</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">Type</span>, <span class="ident">Type</span><span class="op">></span> <span class="kw">where</span> <span class="ident">Q</span>: <span class="ident">Ord</span>, <span class="ident">K</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Q</span><span class="op">></span> { <span class="kw">match</span> <span class="ident">search_linear</span>(<span class="kw-2">&</span><span class="ident">node</span>, <span class="ident">key</span>) { (<span class="ident">idx</span>, <span class="bool-val">true</span>) <span class="op">=></span> <span class="ident">Found</span>( <span class="ident">Handle</span>::<span class="ident">new_kv</span>(<span class="ident">node</span>, <span class="ident">idx</span>) ), (<span class="ident">idx</span>, <span class="bool-val">false</span>) <span class="op">=></span> <span class="ident">SearchResult</span>::<span class="ident">GoDown</span>( <span class="ident">Handle</span>::<span class="ident">new_edge</span>(<span class="ident">node</span>, <span class="ident">idx</span>) ) } } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">search_linear</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">Type</span>, <span class="ident">Q</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span>( <span class="ident">node</span>: <span class="kw-2">&</span><span class="ident">NodeRef</span><span class="op"><</span><span class="ident">BorrowType</span>, <span class="ident">K</span>, <span class="ident">V</span>, <span class="ident">Type</span><span class="op">></span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">Q</span> ) <span class="op">-></span> (<span class="ident">usize</span>, <span class="ident">bool</span>) <span class="kw">where</span> <span class="ident">Q</span>: <span class="ident">Ord</span>, <span class="ident">K</span>: <span class="ident">Borrow</span><span class="op"><</span><span class="ident">Q</span><span class="op">></span> { <span class="kw">for</span> (<span class="ident">i</span>, <span class="ident">k</span>) <span class="kw">in</span> <span class="ident">node</span>.<span class="ident">keys</span>().<span class="ident">iter</span>().<span class="ident">enumerate</span>() { <span class="kw">match</span> <span class="ident">key</span>.<span class="ident">cmp</span>(<span class="ident">k</span>.<span class="ident">borrow</span>()) { <span class="ident">Ordering</span>::<span class="ident">Greater</span> <span class="op">=></span> {}, <span class="ident">Ordering</span>::<span class="ident">Equal</span> <span class="op">=></span> <span class="kw">return</span> (<span class="ident">i</span>, <span class="bool-val">true</span>), <span class="ident">Ordering</span>::<span class="ident">Less</span> <span class="op">=></span> <span class="kw">return</span> (<span class="ident">i</span>, <span class="bool-val">false</span>) } } (<span class="ident">node</span>.<span class="ident">keys</span>().<span class="ident">len</span>(), <span class="bool-val">false</span>) } </pre></div> </section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../../";window.currentCrate = "alloc";</script><script src="../../../../aliases.js"></script><script src="../../../../main1.35.0.js"></script><script src="../../../../source-script1.35.0.js"></script><script src="../../../../source-files.js"></script><script defer src="../../../../search-index.js"></script></body></html>