rust bindings for tskit
This crate provides rust bindings to tskit.
This package provides the following:
- Low-level bindings to the C API of both
tskit
andkastore
. We use bindgen to automatically generate the bindings. - Support for table collections, tree sequences, and tree iteration.
- An error handling system that maps
tskit
error codes torust
errors while preserving error messages.
The overview is:
tskit
andkastore
source fromtskit 0.3.5
are include insubprojects/
- These two tools are compiled into the
rust
package. - Then
bindgen
generates the bindings. - Finally, the entire rust package is generated.
The result is a rust
library with all of these two C libraries statically compiled in.
Further, rust
types and functions exist in the module name tskit::bindings
, allowing unsafe
access to the low-level API.
Help wanted!
Quick start guide
Then, to look at the docs:
cargo doc --open
Change log
See here.