/rust-htslib

This library provides HTSlib bindings and a high level Rust API for reading and writing BAM files.

Primary LanguageRustMIT LicenseMIT

Crates.io Crates.io Crates.io docs.rs Travis

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.

Usage

Add this to your Cargo.toml:

[dependencies]
rust-htslib = "*"

and this to your crate root:

extern crate rust_htslib;

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.