mtbl-sys

Crates.iomtbl-sys
lib.rsmtbl-sys
version0.2.0
sourcesrc
created_at2016-01-02 19:07:41.374277
updated_at2017-01-06 18:56:02.498437
descriptionFFI Bindings to the MTBL C library (https://github.com/farsightsec/mtbl)
homepagehttps://github.com/leon-barrett/mtbl-sys
repositoryhttps://github.com/leon-barrett/mtbl-sys
max_upload_size
id3811
size32,842
Leon Barrett (leon-barrett)

documentation

https://leon-barrett.github.io/mtbl-sys/

README

mtbl Rust Bindings

This library provides Rust FFI interface to the mtbl C library for dealing with SSTables (write-once sorted map files).

SSTables are basically constant on-disk maps, like those used by CDB (which also has Rust bindings, except using sorted maps instead of hashmaps. For more information, see the mtbl README.

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:

[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.

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

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.

Commit count: 9

cargo fmt