# mtbl Rust Bindings

This library provides Rust FFI interface to the
[mtbl](https://github.com/farsightsec/mtbl) C library for dealing with
SSTables (write-once sorted map files).

SSTables are basically constant on-disk maps, like those used by
[CDB](http://www.corpit.ru/mjt/tinycdb.html) (which also has [Rust
bindings](https://github.com/andrew-d/tinycdb-rs), except using sorted maps
instead of hashmaps. For more information, see the [mtbl
README](https://github.com/farsightsec/mtbl).

Version 0.2.X of mtbl-sys covers the 0.8 version of the MTBL C library.

## Dependencies

In order to use the `mtbl-sys` crate, you must have a Unix system with the
`libmtbl` library installed where it can be found by `pkg-config`.

On Debian-based Linux distributions, install the `libmtbl-dev` package:

```
sudo apt-get install libmtbl-dev
```

## Usage

Add `mtbl-sys` as a dependency in `Cargo.toml`:

```toml
[dependencies]
mtbl-sys = "0.1.0"
```

Import the `mtbl_sys` crate and use the functions as they're defined in the
native `libmtbl` library. See the `libmtbl` API documention man pages for
more usage information.

```rust
extern crate mtbl_sys as mtbl;
```

## Function documentation

For documentation about each function, see MTBL's extensive man pages, e.g.
`man mtbl_reader`.

## License

Copyright 2016 Leon Barrett

Licensed under either of
 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.