35 breaking releases

0.36.0 Feb 6, 2025
0.34.0 Dec 12, 2024
0.33.0 Sep 4, 2024
0.32.0 Jul 14, 2024
0.2.0 Jul 21, 2021

#303 in Compression

Download history 1402/week @ 2024-10-26 1288/week @ 2024-11-02 1227/week @ 2024-11-09 1335/week @ 2024-11-16 1461/week @ 2024-11-23 1564/week @ 2024-11-30 1751/week @ 2024-12-07 1742/week @ 2024-12-14 901/week @ 2024-12-21 710/week @ 2024-12-28 1672/week @ 2025-01-04 2388/week @ 2025-01-11 2237/week @ 2025-01-18 2584/week @ 2025-01-25 3529/week @ 2025-02-01 4166/week @ 2025-02-08

13,114 downloads per month
Used in 91 crates (17 directly)

MIT license

135KB
3K 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 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)?;

Write a BGZF file

use noodles_bgzf as bgzf;
let mut writer = File::create("data.gz").map(bgzf::Writer::new)?;
writer.write_all(b"noodles-bgzf")?;

Dependencies

~0.8–7MB
~39K SLoC