28 breaking releases

0.29.0 Mar 28, 2024
0.27.0 Jan 25, 2024
0.26.0 Dec 14, 2023
0.25.0 Nov 14, 2023
0.1.1 Jul 21, 2021

#97 in Biology

Download history 186/week @ 2023-12-22 257/week @ 2023-12-29 310/week @ 2024-01-05 162/week @ 2024-01-12 214/week @ 2024-01-19 533/week @ 2024-01-26 448/week @ 2024-02-02 236/week @ 2024-02-09 521/week @ 2024-02-16 574/week @ 2024-02-23 563/week @ 2024-03-01 801/week @ 2024-03-08 537/week @ 2024-03-15 362/week @ 2024-03-22 486/week @ 2024-03-29 289/week @ 2024-04-05

1,766 downloads per month
Used in 19 crates (3 directly)

MIT license



crates.io Docs.rs CI status

noodles attempts to provide correct implementations of libraries for handling various bioinformatics file formats. It currently supports BAM 1.6, BCF 2.2, BED, BGZF, CRAM 3.0/3.1, CSI, FASTA, FASTQ, GFF3, GTF 2.2, htsget 1.3, refget 2.0, SAM 1.6, tabix, and VCF 4.3/4.4.


noodles is published on crates.io. Early versions can be used in projects, but keep in mind that the API is still considered experimental.

noodles is split into multiple crates by file format. For convenience, a top-level meta crate named noodles can be added to your project's dependency list; and formats, listed as features. For example, to work with the BAM format, enable the bam feature.

noodles = { version = "0.65.0", features = ["bam"] }

Each enabled feature can then be imported by its re-exported name, e.g.,

use noodles::bam;

Feature flags

Individual crates may have optional features that can be enabled using feature flags.

  • async: Enables asynchronous I/O with Tokio. (BAM, BCF, BGZF, CRAM, CSI, FASTA, FASTQ, SAM, tabix, and VCF)
  • libdeflate: Use libdeflate to encode and decode DEFLATE streams. (BGZF and CRAM)


Each crate may have its own examples directory, and all examples are runnable as an application. After cloning the repository, run cargo run --release --example for a list of available examples. Use the example name as the option argument and append program arguments to the command, e.g.,

cargo run --release --example bam_write > sample.bam
cargo run --release --example bam_read_header sample.bam


noodles-gff handles the reading and writing of the GFF3 format.

GFF (Generic Feature Format) is a text-based format used to represent genomic features.


Read all records in a GFF3 file

use noodles_gff as gff;

let mut reader = File::open("annotations.gff3")

for result in reader.records() {
    let record = result?;



~31K SLoC