This crate provides an API to work with immutable (string -> string) maps stored on disk. The main access method are iterators, but there's a simpler API, too.
The general process is
TableBuilder. The entries have to be added in
sorted order. The data doesn't have to be written to disk; any type
implementing Write works.Table. Again, the source is generic; any type
implementing Read + Seek can be used.Note that the tables and some other structures are generic over the ordering of
keys; usually you can just use StandardComparator, though.
With Options, you can influence some details of how tables are laid out on
disk. Usually, you don't need to; just use the Options::default() value.
If there's data corruption in the files on disk, defective blocks will be
skipped. How many entries a single block contains depends on the block size,
which can be set in the Options struct.
This crate reuses code originally written for the persistence part of rusty-leveldb, a reimplementation of Google's LevelDB in Rust. That's the reason for the code being a bit more complicated than needed at some points.
Contributions are very welcome! Feel free to send pull requests.