72 lines
3.9 KiB
HTML
72 lines
3.9 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Module mrdb_index</title>
|
|
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
|
|
</head>
|
|
<body bgcolor="white">
|
|
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
|
|
<hr>
|
|
|
|
<h1>Module mrdb_index</h1>
|
|
<ul class="index"><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
|
|
|
|
|
|
<h2><a name="types">Data Types</a></h2>
|
|
|
|
<h3 class="typedecl"><a name="type-index_value">index_value()</a></h3>
|
|
<p><tt>index_value() = any()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-iterator_action">iterator_action()</a></h3>
|
|
<p><tt>iterator_action() = <a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-iterator_action">mrdb:iterator_action()</a></tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-ix_iterator">ix_iterator()</a></h3>
|
|
<p><tt>ix_iterator() = #mrdb_ix_iter{i = <a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-iterator">mrdb:iterator()</a>, type = set | bag, sub = <a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-ref">mrdb:ref()</a> | pid()}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-object">object()</a></h3>
|
|
<p><tt>object() = tuple()</tt></p>
|
|
|
|
|
|
<h2><a name="index">Function Index</a></h2>
|
|
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><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="#with_iterator-3">with_iterator/3</a></td><td></td></tr>
|
|
</table>
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
<h3 class="function"><a name="iterator-2">iterator/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>iterator(Tab::<a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-ref_or_tab">mrdb:ref_or_tab()</a>, IxPos::<a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-index_position">mrdb:index_position()</a>) -> {ok, <a href="#type-ix_iterator">ix_iterator()</a>} | {error, term()}</tt><br></p>
|
|
<p> </p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="iterator_close-1">iterator_close/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>iterator_close(Mrdb_ix_iter::<a href="#type-ix_iterator">ix_iterator()</a>) -> ok</tt><br></p>
|
|
<p> </p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="iterator_move-2">iterator_move/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>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()}</tt><br></p>
|
|
<p> </p>
|
|
</div>
|
|
|
|
<h3 class="function"><a name="with_iterator-3">with_iterator/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>with_iterator(Tab::<a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-ref_or_tab">mrdb:ref_or_tab()</a>, IxPos::<a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-index_position">mrdb:index_position()</a>, Fun::fun((<a href="#type-ix_iterator">ix_iterator()</a>) -> Res)) -> Res</tt><br></p>
|
|
<p> </p>
|
|
</div>
|
|
<hr>
|
|
|
|
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
|
|
<p><i>Generated by EDoc</i></p>
|
|
</body>
|
|
</html>
|