search.rs.html -- source
Description: Source to the Rust file `liballoc/collections/btree/search.rs`.
Keywords: rust, rustlang, rust-lang

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75

    // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    use core::cmp::Ordering;

    use borrow::Borrow;

    use super::node::{Handle, NodeRef, marker};

    use super::node::ForceResult::*;
    use self::SearchResult::*;

    pub enum SearchResult<BorrowType, K, V, FoundType, GoDownType> {
        Found(Handle<NodeRef<BorrowType, K, V, FoundType>, marker::KV>),
        GoDown(Handle<NodeRef<BorrowType, K, V, GoDownType>, marker::Edge>)
    }

    pub fn search_tree<BorrowType, K, V, Q: ?Sized>(
        mut node: NodeRef<BorrowType, K, V, marker::LeafOrInternal>,
        key: &Q
    ) -> SearchResult<BorrowType, K, V, marker::LeafOrInternal, marker::Leaf>
            where Q: Ord, K: Borrow<Q> {

        loop {
            match search_node(node, key) {
                Found(handle) => return Found(handle),
                GoDown(handle) => match handle.force() {
                    Leaf(leaf) => return GoDown(leaf),
                    Internal(internal) => {
                        node = internal.descend();
                        continue;
                    }
                }
            }
        }
    }

    pub fn search_node<BorrowType, K, V, Type, Q: ?Sized>(
        node: NodeRef<BorrowType, K, V, Type>,
        key: &Q
    ) -> SearchResult<BorrowType, K, V, Type, Type>
            where Q: Ord, K: Borrow<Q> {

        match search_linear(&node, key) {
            (idx, true) => Found(
                Handle::new_kv(node, idx)
            ),
            (idx, false) => SearchResult::GoDown(
                Handle::new_edge(node, idx)
            )
        }
    }

    pub fn search_linear<BorrowType, K, V, Type, Q: ?Sized>(
        node: &NodeRef<BorrowType, K, V, Type>,
        key: &Q
    ) -> (usize, bool)
            where Q: Ord, K: Borrow<Q> {

        for (i, k) in node.keys().iter().enumerate() {
            match key.cmp(k.borrow()) {
                Ordering::Greater => {},
                Ordering::Equal => return (i, true),
                Ordering::Less => return (i, false)
            }
        }
        (node.keys().len(), false)
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)