Skip to content

Latest commit

 

History

History
99 lines (51 loc) · 2.6 KB

mrdb_index.md

File metadata and controls

99 lines (51 loc) · 2.6 KB

Module mrdb_index

Data Types


index_value() = any()

iterator_action() = mrdb:iterator_action()

ix_iterator() = #mrdb_ix_iter{i = mrdb:iterator(), type = set | bag, sub = mrdb:ref() | pid()}

object() = tuple()

Function Index

iterator/2
iterator_close/1
iterator_move/2
with_iterator/3

Function Details

iterator/2


iterator(Tab::mrdb:ref_or_tab(), IxPos::mrdb:index_position()) -> {ok, ix_iterator()} | {error, term()}

iterator_close/1


iterator_close(Mrdb_ix_iter::ix_iterator()) -> ok

iterator_move/2


iterator_move(Mrdb_ix_iter::ix_iterator(), Dir::iterator_action()) -> {ok, index_value(), object()} | {error, term()}

with_iterator/3


with_iterator(Tab::mrdb:ref_or_tab(), IxPos::mrdb:index_position(), Fun::fun((ix_iterator()) -> Res)) -> Res