19 breaking releases
0.20.0 | Mar 3, 2023 |
---|---|
0.18.0 | Nov 18, 2022 |
0.13.0 | Jul 5, 2022 |
0.11.0 | Mar 29, 2022 |
0.2.0 | Jul 21, 2021 |
#59 in Compression
2,070 downloads per month
Used in 28 crates
(12 directly)
100KB
2.5K
SLoC
noodles-bgzf handles the reading and writing of the blocked gzip format (BGZF).
While the gzip format is typically a single stream, a BGZF is the concatenation of many gzip
streams. Each stream is called a block, with its uncompressed data size being constrained to
less than 64 KiB. This multistream gzip allows random access using virtual positions
.
noodles-bgzf abstracts away the concept of blocks, implementing [std::io::Read
] for the
reader and [std::io::Write
] for the writer.
Examples
Read an entire BGZF file
# use std::{fs::File, io::{self, Read}};
use noodles_bgzf as bgzf;
let mut reader = File::open("data.gz").map(bgzf::Reader::new)?;
let mut data = Vec::new();
reader.read_to_end(&mut data)?;
# Ok::<(), io::Error>(())
Write a BGZF file
# use std::{fs::File, io::{self, Write}};
use noodles_bgzf as bgzf;
let mut writer = File::create("data.gz").map(bgzf::Writer::new)?;
writer.write_all(b"noodles-bgzf")?;
# Ok::<(), io::Error>(())
Dependencies
~0.7–5.5MB
~79K SLoC