stable_bst 0.2.0

An ordered map and set based on a binary search tree. Works with stable Rust 1.9.0.
Documentation 
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

<!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="API documentation for the Rust `Extract` struct in crate `compare`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, Extract">

    <title>compare::Extract - Rust</title>

    <link rel="stylesheet" type="text/css" href="../rustdoc.css">
    <link rel="stylesheet" type="text/css" href="../main.css">
    

    
    
</head>
<body class="rustdoc">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        
        <p class='location'><a href='index.html'>compare</a></p><script>window.sidebarCurrent = {name: 'Extract', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
    </nav>

    <nav class="sub">
        <form class="search-form js-only">
            <div class="search-container">
                <input class="search-input" name="search"
                       autocomplete="off"
                       placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                       type="search">
            </div>
        </form>
    </nav>

    <section id='main' class="content struct">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>compare</a>::<wbr><a class='struct' href=''>Extract</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a id='src-150' class='srclink' href='../src/compare/lib.rs.html#373-376' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Extract&lt;E, C&gt; {
    // some fields omitted
}</pre><div class='docblock'><p>A comparator that extracts a sort key from a value.</p>

<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>compare</span>::{<span class='ident'>Compare</span>, <span class='ident'>Extract</span>};
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>cmp</span>::<span class='ident'>Ordering</span>::<span class='ident'>Greater</span>;

<span class='kw'>let</span> <span class='ident'>a</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>];
<span class='kw'>let</span> <span class='ident'>b</span> <span class='op'>=</span> [<span class='number'>4</span>, <span class='number'>5</span>];

<span class='kw'>let</span> <span class='ident'>cmp</span> <span class='op'>=</span> <span class='ident'>Extract</span>::<span class='ident'>new</span>(<span class='op'>|</span><span class='ident'>s</span>: <span class='kw-2'>&amp;</span>[<span class='ident'>i32</span>]<span class='op'>|</span> <span class='ident'>s</span>.<span class='ident'>len</span>());
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>cmp</span>.<span class='ident'>compare</span>(<span class='kw-2'>&amp;</span><span class='ident'>a</span>, <span class='kw-2'>&amp;</span><span class='ident'>b</span>), <span class='ident'>Greater</span>);</pre>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl&lt;E, K&gt; <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, <a class='struct' href='../compare/struct.Natural.html' title='compare::Natural'>Natural</a>&lt;K&gt;&gt; <span class='where'>where K: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html' title='core::cmp::Ord'>Ord</a></span></code></h3><div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>&lt;T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a>&gt;(ext: E) -&gt; Self <span class='where'>where E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(&amp;T) -&gt; K</span></code></h4>
<div class='docblock'><p>Returns a comparator that extracts a sort key using <code>ext</code> and compares it according to its
natural ordering.</p>
</div></div><h3 class='impl'><code>impl&lt;E, C&gt; <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h3><div class='impl-items'><h4 id='method.with_cmp' class='method'><code>fn <a href='#method.with_cmp' class='fnname'>with_cmp</a>&lt;T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a>, K&gt;(ext: E, cmp: C) -&gt; Self <span class='where'>where E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(&amp;T) -&gt; K, C: <a class='trait' href='../compare/trait.Compare.html' title='compare::Compare'>Compare</a>&lt;K&gt;</span></code></h4>
<div class='docblock'><p>Returns a comparator that extracts a sort key using <code>ext</code> and compares it using
<code>cmp</code>.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl&lt;E, C, T: ?<a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a>, K&gt; <a class='trait' href='../compare/trait.Compare.html' title='compare::Compare'>Compare</a>&lt;T&gt; for <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt; <span class='where'>where E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(&amp;T) -&gt; K, C: <a class='trait' href='../compare/trait.Compare.html' title='compare::Compare'>Compare</a>&lt;K&gt;</span></code></h3><div class='impl-items'><h4 id='method.compare' class='method'><code>fn <a href='../compare/trait.Compare.html#tymethod.compare' class='fnname'>compare</a>(&amp;self, l: &amp;T, r: &amp;T) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html' title='core::cmp::Ordering'>Ordering</a></code></h4>
<h4 id='method.compares_lt' class='method'><code>fn <a href='../compare/trait.Compare.html#method.compares_lt' class='fnname'>compares_lt</a>(&amp;self, l: &amp;T, r: &amp;T) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.compares_le' class='method'><code>fn <a href='../compare/trait.Compare.html#method.compares_le' class='fnname'>compares_le</a>(&amp;self, l: &amp;T, r: &amp;T) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.compares_ge' class='method'><code>fn <a href='../compare/trait.Compare.html#method.compares_ge' class='fnname'>compares_ge</a>(&amp;self, l: &amp;T, r: &amp;T) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.compares_gt' class='method'><code>fn <a href='../compare/trait.Compare.html#method.compares_gt' class='fnname'>compares_gt</a>(&amp;self, l: &amp;T, r: &amp;T) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.compares_eq' class='method'><code>fn <a href='../compare/trait.Compare.html#method.compares_eq' class='fnname'>compares_eq</a>(&amp;self, l: &amp;T, r: &amp;T) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.compares_ne' class='method'><code>fn <a href='../compare/trait.Compare.html#method.compares_ne' class='fnname'>compares_ne</a>(&amp;self, l: &amp;T, r: &amp;T) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.borrowing' class='method'><code>fn <a href='../compare/trait.Compare.html#method.borrowing' class='fnname'>borrowing</a>(self) -&gt; <a class='struct' href='../compare/struct.Borrowing.html' title='compare::Borrowing'>Borrowing</a>&lt;Self, L, R&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.rev' class='method'><code>fn <a href='../compare/trait.Compare.html#method.rev' class='fnname'>rev</a>(self) -&gt; <a class='struct' href='../compare/struct.Rev.html' title='compare::Rev'>Rev</a>&lt;Self&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.swap' class='method'><code>fn <a href='../compare/trait.Compare.html#method.swap' class='fnname'>swap</a>(self) -&gt; <a class='struct' href='../compare/struct.Swap.html' title='compare::Swap'>Swap</a>&lt;Self&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.then' class='method'><code>fn <a href='../compare/trait.Compare.html#method.then' class='fnname'>then</a>&lt;D&gt;(self, then: D) -&gt; <a class='struct' href='../compare/struct.Then.html' title='compare::Then'>Then</a>&lt;Self, D&gt; <span class='where'>where D: <a class='trait' href='../compare/trait.Compare.html' title='compare::Compare'>Compare</a>&lt;L, R&gt;, Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
</div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl&lt;E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html' title='core::cmp::Eq'>Eq</a>, C: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html' title='core::cmp::Eq'>Eq</a>&gt; <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html' title='core::cmp::Eq'>Eq</a> for <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h3><div class='impl-items'></div><h3 class='impl'><code>impl&lt;E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a>, C: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a>&gt; <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title='core::cmp::PartialEq'>PartialEq</a> for <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h3><div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.ne' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a></code></h4>
</div><h3 class='impl'><code>impl&lt;E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html' title='core::default::Default'>Default</a>, C: <a class='trait' href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html' title='core::default::Default'>Default</a>&gt; <a class='trait' href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html' title='core::default::Default'>Default</a> for <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h3><div class='impl-items'><h4 id='method.default' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h4>
</div><h3 class='impl'><code>impl&lt;E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a>, C: <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a>&gt; <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -&gt; <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4>
</div><h3 class='impl'><code>impl&lt;E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a>, C: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a>&gt; <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a> for <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h3><div class='impl-items'></div><h3 class='impl'><code>impl&lt;E: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>, C: <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a>&gt; <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='struct' href='../compare/struct.Extract.html' title='compare::Extract'>Extract</a>&lt;E, C&gt;</code></h4>
<h4 id='method.clone_from' class='method'><span class="since">1.0.0</span><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code></h4>
</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>?</dt>
                    <dd>Show this help dialog</dd>
                    <dt>S</dt>
                    <dd>Focus the search field</dd>
                    <dt>&larrb;</dt>
                    <dd>Move up in search results</dd>
                    <dt>&rarrb;</dt>
                    <dd>Move down in search results</dd>
                    <dt>&#9166;</dt>
                    <dd>Go to active search result</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>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../";
        window.currentCrate = "compare";
        window.playgroundUrl = "";
    </script>
    <script src="../jquery.js"></script>
    <script src="../main.js"></script>
    
    <script defer src="../search-index.js"></script>
</body>
</html>