153 lines
4.8 KiB
Markdown
153 lines
4.8 KiB
Markdown
|
|
|
|
# Module mrdb_index #
|
|
* [Data Types](#types)
|
|
* [Function Index](#index)
|
|
* [Function Details](#functions)
|
|
|
|
<a name="types"></a>
|
|
|
|
## Data Types ##
|
|
|
|
|
|
|
|
|
|
### <a name="type-index_value">index_value()</a> ###
|
|
|
|
|
|
<pre><code>
|
|
index_value() = any()
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
### <a name="type-iterator_action">iterator_action()</a> ###
|
|
|
|
|
|
<pre><code>
|
|
iterator_action() = <a href="http://www.erlang.org/doc/man/mrdb.html#type-iterator_action">mrdb:iterator_action()</a>
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
### <a name="type-ix_iterator">ix_iterator()</a> ###
|
|
|
|
|
|
<pre><code>
|
|
ix_iterator() = #mrdb_ix_iter{i = <a href="http://www.erlang.org/doc/man/mrdb.html#type-mrdb_iterator">mrdb:mrdb_iterator()</a>, type = set | bag, sub = pid() | <a href="http://www.erlang.org/doc/man/mrdb.html#type-db_ref">mrdb:db_ref()</a>}
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
### <a name="type-object">object()</a> ###
|
|
|
|
|
|
<pre><code>
|
|
object() = tuple()
|
|
</code></pre>
|
|
|
|
<a name="index"></a>
|
|
|
|
## Function Index ##
|
|
|
|
|
|
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#fold-4">fold/4</a></td><td></td></tr><tr><td valign="top"><a href="#index_ref-2">index_ref/2</a></td><td></td></tr><tr><td valign="top"><a href="#iterator-2">iterator/2</a></td><td></td></tr><tr><td valign="top"><a href="#iterator_close-1">iterator_close/1</a></td><td></td></tr><tr><td valign="top"><a href="#iterator_move-2">iterator_move/2</a></td><td></td></tr><tr><td valign="top"><a href="#rev_fold-4">rev_fold/4</a></td><td></td></tr><tr><td valign="top"><a href="#select-3">select/3</a></td><td></td></tr><tr><td valign="top"><a href="#select-4">select/4</a></td><td></td></tr><tr><td valign="top"><a href="#select_reverse-3">select_reverse/3</a></td><td></td></tr><tr><td valign="top"><a href="#select_reverse-4">select_reverse/4</a></td><td></td></tr><tr><td valign="top"><a href="#with_iterator-3">with_iterator/3</a></td><td></td></tr></table>
|
|
|
|
|
|
<a name="functions"></a>
|
|
|
|
## Function Details ##
|
|
|
|
<a name="fold-4"></a>
|
|
|
|
### fold/4 ###
|
|
|
|
<pre><code>
|
|
fold(Tab::<a href="http://www.erlang.org/doc/man/mrdb.html#type-ref_or_tab">mrdb:ref_or_tab()</a>, IxPos::<a href="http://www.erlang.org/doc/man/mrdb.html#type-index_position">mrdb:index_position()</a>, FoldFun::fun((<a href="#type-index_value">index_value()</a>, <a href="#type-object">object()</a> | [], Acc) -> Acc), Acc) -> Acc
|
|
</code></pre>
|
|
|
|
<ul class="definitions"><li><code>Acc = any()</code></li></ul>
|
|
|
|
<a name="index_ref-2"></a>
|
|
|
|
### index_ref/2 ###
|
|
|
|
<pre><code>
|
|
index_ref(Tab::<a href="http://www.erlang.org/doc/man/mrdb.html#type-ref_or_tab">mrdb:ref_or_tab()</a>, Ix::<a href="http://www.erlang.org/doc/man/mrdb.html#type-index_position">mrdb:index_position()</a>) -> <a href="http://www.erlang.org/doc/man/mrdb.html#type-db_ref">mrdb:db_ref()</a>
|
|
</code></pre>
|
|
<br />
|
|
|
|
<a name="iterator-2"></a>
|
|
|
|
### iterator/2 ###
|
|
|
|
<pre><code>
|
|
iterator(Tab::<a href="http://www.erlang.org/doc/man/mrdb.html#type-ref_or_tab">mrdb:ref_or_tab()</a>, IxPos::<a href="http://www.erlang.org/doc/man/mrdb.html#type-index_position">mrdb:index_position()</a>) -> {ok, <a href="#type-ix_iterator">ix_iterator()</a>} | {error, term()}
|
|
</code></pre>
|
|
<br />
|
|
|
|
<a name="iterator_close-1"></a>
|
|
|
|
### iterator_close/1 ###
|
|
|
|
<pre><code>
|
|
iterator_close(Mrdb_ix_iter::<a href="#type-ix_iterator">ix_iterator()</a>) -> ok
|
|
</code></pre>
|
|
<br />
|
|
|
|
<a name="iterator_move-2"></a>
|
|
|
|
### iterator_move/2 ###
|
|
|
|
<pre><code>
|
|
iterator_move(Mrdb_ix_iter::<a href="#type-ix_iterator">ix_iterator()</a>, Dir::<a href="#type-iterator_action">iterator_action()</a>) -> {ok, <a href="#type-index_value">index_value()</a>, <a href="#type-object">object()</a>} | {error, term()}
|
|
</code></pre>
|
|
<br />
|
|
|
|
<a name="rev_fold-4"></a>
|
|
|
|
### rev_fold/4 ###
|
|
|
|
<pre><code>
|
|
rev_fold(Tab::<a href="http://www.erlang.org/doc/man/mrdb.html#type-ref_or_tab">mrdb:ref_or_tab()</a>, IxPos::<a href="http://www.erlang.org/doc/man/mrdb.html#type-index_position">mrdb:index_position()</a>, FoldFun::fun((<a href="#type-index_value">index_value()</a>, <a href="#type-object">object()</a> | [], Acc) -> Acc), Acc) -> Acc
|
|
</code></pre>
|
|
|
|
<ul class="definitions"><li><code>Acc = any()</code></li></ul>
|
|
|
|
<a name="select-3"></a>
|
|
|
|
### select/3 ###
|
|
|
|
`select(Tab, Ix, MS) -> any()`
|
|
|
|
<a name="select-4"></a>
|
|
|
|
### select/4 ###
|
|
|
|
`select(Tab, Ix, MS, Limit) -> any()`
|
|
|
|
<a name="select_reverse-3"></a>
|
|
|
|
### select_reverse/3 ###
|
|
|
|
`select_reverse(Tab, Ix, MS) -> any()`
|
|
|
|
<a name="select_reverse-4"></a>
|
|
|
|
### select_reverse/4 ###
|
|
|
|
`select_reverse(Tab, Ix, MS, Limit) -> any()`
|
|
|
|
<a name="with_iterator-3"></a>
|
|
|
|
### with_iterator/3 ###
|
|
|
|
<pre><code>
|
|
with_iterator(Tab::<a href="http://www.erlang.org/doc/man/mrdb.html#type-ref_or_tab">mrdb:ref_or_tab()</a>, IxPos::<a href="http://www.erlang.org/doc/man/mrdb.html#type-index_position">mrdb:index_position()</a>, Fun::fun((<a href="#type-ix_iterator">ix_iterator()</a>) -> Res)) -> Res
|
|
</code></pre>
|
|
<br />
|
|
|