HTSlib bindings for Rust
This library provides HTSlib bindings and a high level Rust API for reading and writing BAM files.
To clone this repository, issue
git clone --recursive https://github.com/rust-bio/rust-htslib.git
ensuring that the HTSlib submodule is fetched, too. If you only want to use the library, there is no need to clone the repository. Go on to the Usage section in this case.
Requirements
To compile this crate you need the development headers of zlib, bzip2 and xz. For instance, in Debian systems one needs the following dependencies:
$ sudo apt-get install zlib1g-dev libbz2-dev liblzma-dev clang
On OSX, this will take a significant amount of time due to musl cross compiling toolchain:
$ brew install FiloSottile/musl-cross/musl-cross
$ brew install bzip2 zlib xz curl-openssl
Usage
Add this to your Cargo.toml:
[]
= "*"
By default rust-htslib links to bzip2-sys and lzma-sys for full CRAM support. If you do not need CRAM support, or you do need to support CRAM files
with these compression methods, you can deactivate these features to reduce you dependency count:
[]
= { = "*", = false }
rust-htslib also has optional support for serde, to allow (de)serialization of bam::Record via any serde-supported format:
[]
= { = "*", = ["serde"] }
For more information, please see the docs.
Authors
For other contributors, see here.
License
Licensed under the MIT license http://opensource.org/licenses/MIT. This project may not be copied, modified, or distributed except according to those terms.