Skip to main content

rsomics_bam_checksum/
lib.rs

1/// Order-independent BAM checksum algorithm, porting samtools checksum (MIT).
2///
3/// ## Origin
4///
5/// This crate is an independent Rust reimplementation of `samtools checksum`
6/// based on:
7/// - The samtools source: `bam_checksum.c` (MIT, Copyright 2024-2025 Genome
8///   Research Ltd., Author: James Bonfield)
9/// - The SAM/BAM format specification (SAMv1)
10/// - Black-box behaviour testing against the upstream binary
11///
12/// The upstream source is MIT-licensed; reading and citing it is permitted.
13/// Source URL: <https://github.com/samtools/samtools/blob/1.23.1/bam_checksum.c>
14///
15/// License: MIT OR Apache-2.0.
16/// Upstream credit: samtools <https://github.com/samtools/samtools> (MIT).
17pub mod checksum;
18pub use checksum::{ChecksumOpts, ChecksumResult, run_checksum};