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 `OrderedMapIterator` trait in crate `ordered_iter`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, OrderedMapIterator">

    <title>ordered_iter::OrderedMapIterator - 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'>ordered_iter</a></p><script>window.sidebarCurrent = {name: 'OrderedMapIterator', ty: 'trait', 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 trait">
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>ordered_iter</a>::<wbr><a class='trait' href=''>OrderedMapIterator</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-10' class='srclink' href='../src/ordered_iter/lib.rs.html#19-55' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait OrderedMapIterator: <a class='trait' href='https://doc.rust-lang.org/nightly/core/iter/trait.Iterator.html' title='core::iter::Iterator'>Iterator</a>&lt;Item=<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(</a>Self::Key, Self::Val<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>)</a>&gt; + <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a> {
    type <a href='#associatedtype.Key' class='type'>Key</a>;
    type <a href='#associatedtype.Val' class='type'>Val</a>;
    fn <a href='#method.inner_join_map' class='fnname'>inner_join_map</a>&lt;I&gt;(self, map: I) -&gt; <a class='struct' href='../ordered_iter/struct.InnerJoinMap.html' title='ordered_iter::InnerJoinMap'>InnerJoinMap</a>&lt;Self, I&gt; <span class='where'>where I: <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a>&lt;Key=Self::<a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>Key</a>&gt;</span> { ... }
    fn <a href='#method.inner_join_set' class='fnname'>inner_join_set</a>&lt;I&gt;(self, set: I) -&gt; <a class='struct' href='../ordered_iter/struct.InnerJoinMapSet.html' title='ordered_iter::InnerJoinMapSet'>InnerJoinMapSet</a>&lt;Self, I&gt; <span class='where'>where I: <a class='trait' href='../ordered_iter/trait.OrderedSetIterator.html' title='ordered_iter::OrderedSetIterator'>OrderedSetIterator</a>&lt;Item=Self::<a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>Key</a>&gt;</span> { ... }
    fn <a href='#method.outer_join' class='fnname'>outer_join</a>&lt;I&gt;(self, other: I) -&gt; <a class='struct' href='../ordered_iter/struct.OuterJoin.html' title='ordered_iter::OuterJoin'>OuterJoin</a>&lt;Self, I&gt; <span class='where'>where I: <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a>&lt;Key=Self::<a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>Key</a>&gt;</span> { ... }
}</pre><div class='docblock'><p>Allows an iterator to do an inner join with another
iterator to combine their values or filter based on their keys.</p>

<p>This trait is applied to an iterator over a map-like structure.</p>
</div>
            <h2 id='associated-types'>Associated Types</h2>
            <div class='methods'>
        <h3 id='associatedtype.Key' class='method stab '><code>type <a href='#associatedtype.Key' class='type'>Key</a></code></h3><h3 id='associatedtype.Val' class='method stab '><code>type <a href='#associatedtype.Val' class='type'>Val</a></code></h3></div>
            <h2 id='provided-methods'>Provided Methods</h2>
            <div class='methods'>
        <h3 id='method.inner_join_map' class='method stab '><code>fn <a href='#method.inner_join_map' class='fnname'>inner_join_map</a>&lt;I&gt;(self, map: I) -&gt; <a class='struct' href='../ordered_iter/struct.InnerJoinMap.html' title='ordered_iter::InnerJoinMap'>InnerJoinMap</a>&lt;Self, I&gt; <span class='where'>where I: <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a>&lt;Key=Self::<a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>Key</a>&gt;</span></code></h3><div class='docblock'><p>Joins two ordered maps together.</p>
</div><h3 id='method.inner_join_set' class='method stab '><code>fn <a href='#method.inner_join_set' class='fnname'>inner_join_set</a>&lt;I&gt;(self, set: I) -&gt; <a class='struct' href='../ordered_iter/struct.InnerJoinMapSet.html' title='ordered_iter::InnerJoinMapSet'>InnerJoinMapSet</a>&lt;Self, I&gt; <span class='where'>where I: <a class='trait' href='../ordered_iter/trait.OrderedSetIterator.html' title='ordered_iter::OrderedSetIterator'>OrderedSetIterator</a>&lt;Item=Self::<a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>Key</a>&gt;</span></code></h3><div class='docblock'><p>Filters an ordered map with an ordered set.</p>
</div><h3 id='method.outer_join' class='method stab '><code>fn <a href='#method.outer_join' class='fnname'>outer_join</a>&lt;I&gt;(self, other: I) -&gt; <a class='struct' href='../ordered_iter/struct.OuterJoin.html' title='ordered_iter::OuterJoin'>OuterJoin</a>&lt;Self, I&gt; <span class='where'>where I: <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a>&lt;Key=Self::<a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>Key</a>&gt;</span></code></h3><div class='docblock'><p>Joins an ordered iterator with another ordered iterator.</p>

<p>The new iterator will return a key-value pair for every key in
either iterator. If a key is present in both iterators, they
will be returned together (two values). If a value is in <code>other</code>
but not <code>self</code>, it will be returned without the value in
<code>self</code>. If the value is in <code>self</code> but not <code>other</code>,
it will be returned without the value from <code>other</code>.</p>
</div></div>
        <h2 id='implementors'>Implementors</h2>
        <ul class='item-list' id='implementors-list'>
    <li><code>impl&lt;'a, K: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html' title='core::cmp::Ord'>Ord</a>, V&gt; <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a> for <a class='struct' href='https://doc.rust-lang.org/nightly/collections/btree/map/struct.Iter.html' title='collections::btree::map::Iter'>Iter</a>&lt;'a, K, V&gt;</code></li>
<li><code>impl&lt;K: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html' title='core::cmp::Ord'>Ord</a>, V&gt; <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a> for <a class='struct' href='https://doc.rust-lang.org/nightly/collections/btree/map/struct.IntoIter.html' title='collections::btree::map::IntoIter'>IntoIter</a>&lt;K, V&gt;</code></li>
<li><code>impl&lt;'a, K: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html' title='core::cmp::Ord'>Ord</a>, V&gt; <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a> for <a class='struct' href='https://doc.rust-lang.org/nightly/collections/btree/map/struct.IterMut.html' title='collections::btree::map::IterMut'>IterMut</a>&lt;'a, K, V&gt;</code></li>
<li><code>impl&lt;'a, V&gt; <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a> for <a class='struct' href='../vec_map/struct.Iter.html' title='vec_map::Iter'>Iter</a>&lt;'a, V&gt;</code></li>
<li><code>impl&lt;A, B&gt; <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a> for <a class='struct' href='../ordered_iter/struct.InnerJoinMap.html' title='ordered_iter::InnerJoinMap'>InnerJoinMap</a>&lt;A, B&gt; <span class='where'>where A: <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a>, B: <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a>&lt;Key=A::Key&gt;, A::Key: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html' title='core::cmp::Ord'>Ord</a></span></code></li>
<li><code>impl&lt;A, B&gt; <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a> for <a class='struct' href='../ordered_iter/struct.InnerJoinMapSet.html' title='ordered_iter::InnerJoinMapSet'>InnerJoinMapSet</a>&lt;A, B&gt; <span class='where'>where A: <a class='trait' href='../ordered_iter/trait.OrderedMapIterator.html' title='ordered_iter::OrderedMapIterator'>OrderedMapIterator</a>, B: <a class='trait' href='../ordered_iter/trait.OrderedSetIterator.html' title='ordered_iter::OrderedSetIterator'>OrderedSetIterator</a>&lt;Item=A::Key&gt;, A::Key: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html' title='core::cmp::Ord'>Ord</a></span></code></li>
</ul><script type="text/javascript" async
                         src="../implementors/ordered_iter/trait.OrderedMapIterator.js">
                 </script></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 = "ordered_iter";
        window.playgroundUrl = "";
    </script>
    <script src="../jquery.js"></script>
    <script src="../main.js"></script>
    
    <script defer src="../search-index.js"></script>
</body>
</html>