Skip to main content

paraseq/
lib.rs

1#![doc = include_str!("../README.md")]
2
3mod base;
4mod buffer;
5#[cfg(feature = "niffler")]
6mod builder;
7mod error;
8pub mod fasta;
9pub mod fastq;
10pub mod fastx;
11pub mod parallel;
12pub mod prelude;
13mod record;
14
15#[cfg(test)]
16pub(crate) mod test_util;
17
18#[cfg(feature = "htslib")]
19pub mod htslib;
20
21#[cfg(feature = "htslib")]
22pub extern crate rust_htslib;
23
24#[cfg(any(feature = "ssh", feature = "gcs"))]
25pub mod remote;
26
27#[cfg(feature = "niffler")]
28pub use builder::ReaderBuilder;
29pub use error::{Error, IntoParaseqError, Result};
30pub use record::Record;
31
32/// Default maximum number of records in a record set.
33pub const DEFAULT_MAX_RECORDS: usize = 1024;
34/// The maximum number of record segments supported in a single synchronized record group.
35/// For example, single-end reads have arity 1, paired-end reads have arity 2, etc.
36pub const MAX_ARITY: usize = 8;
37
38/// A boxed reader trait object used by many functions in this crate.
39pub type BoxedReader = Box<dyn std::io::Read + Send>;