Mercurial > lbo > hg > sstable
view README.md @ 73:27972ad163c8
Add badges for crates.io/travis
author | Lewin Bormann <lbo@spheniscida.de> |
---|---|
date | Mon, 17 Feb 2020 15:46:56 +0100 |
parents | b557e42af582 |
children | bc127bc534b5 |
line wrap: on
line source
# sstable [![crates.io](https://img.shields.io/crates/v/sstable.svg)](https://crates.io/crates/sstable) [![Travis CI](https://api.travis-ci.org/dermesser/sstable.svg?branch=master)](https://api.travis-ci.org/dermesser/sstable) [Documentation](https://docs.rs/sstable) 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 * Writing a table, using `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. * Reading a table, using `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. Contributions are very welcome!