bgzf
| Crates.io | bgzf |
| lib.rs | bgzf |
| version | 0.2.0 |
| source | src |
| created_at | 2022-03-04 20:06:56.478835 |
| updated_at | 2022-03-04 20:06:56.478835 |
| description | Utility library for working with explicitly BGZF compressed data |
| homepage | https://github.com/fulcrumgenomics/bgzf |
| repository | https://github.com/fulcrumgenomics/bgzf |
| max_upload_size | |
| id | 543654 |
| size | 31,877 |
Tim Fennell (tfenne)
documentation
https://docs.rs/bgzf
README
bgzf
This library provides both high level readers and writers for the BGZF format as well as lower level compressor and decompressor functions.
Bgzf is a multi-gzip format that adds an extra field to the header indicating how large the complete block (with header and footer) is.
Documentation and Examples
Please see the generated Rust Docs.
How to use in your project
Add the following to your Cargo.toml dependencies section, updating the version number as needed.
[dependencies]
bgzf = "*"
How to build and test locally
Assuming you have cloned the repo and are in the top level:
cargo test
# The following test is more comprehensive and may take up to 10 minutes to run
cargo test -- --ignored
How to publish
This assumes that you have installed cargo-release via cargo install cargo-release and have set up credentials with crates.io.
cargo release <path|minor|major>