biotest 0.2.0

Generate random test data for bioinformatics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! Error struct of project biotest

/* crate use */
use thiserror;

/// Enum to manage error
#[derive(std::fmt::Debug, thiserror::Error)]
pub enum Error {
    /// WeightedDistribution is larger than value
    #[error("Weight array is larger than value array")]
    WeightArrayLargerValueArray,

    /// unreachable
    #[error("Unreachable error from file {file} in line {line}")]
    Unreachable {
        /// line number
        line: u32,
        /// file name
        file: &'static str,
    },

    /// std::io::Error error
    #[error(transparent)]
    StdIo(#[from] std::io::Error),

    /// rand::distributions::weighted::WeightedError
    #[error(transparent)]
    RandWeightedError(#[from] rand::distributions::weighted::WeightedError),

    /// biotest::format::fasta::FastaBuilderError
    #[cfg(feature = "fasta")]
    #[error(transparent)]
    FastaBuilderError(#[from] crate::format::fasta::FastaBuilderError),

    /// crate::format::fastq::FastqBuilderError
    #[cfg(feature = "fastq")]
    #[error(transparent)]
    FastqBuilderError(#[from] crate::format::fastq::FastqBuilderError),

    /// crate::format::vcf::VcfBuilderError
    #[cfg(feature = "vcf")]
    #[error(transparent)]
    VcfBuilderError(#[from] crate::format::vcf::VcfBuilderError),

    /// crate::format::vcf::record::RecordBuilderError
    #[cfg(feature = "vcf")]
    #[error(transparent)]
    VcfRecordBuilderError(#[from] crate::format::vcf::record::RecordBuilderError),

    /// crate::format::vcf::header::HeaderBuilderError
    #[cfg(feature = "vcf")]
    #[error(transparent)]
    VcfHeaderBuilderError(#[from] crate::format::vcf::header::HeaderBuilderError),

    /// crate::format::sequence::SequenceBuilderError
    #[cfg(feature = "sequence")]
    #[error(transparent)]
    SequenceBuilderError(#[from] crate::format::sequence::SequenceBuilderError),

    /// crate::format::quality::QualityBuilderError
    #[cfg(feature = "quality")]
    #[error(transparent)]
    QualityBuilderError(#[from] crate::format::quality::QualityBuilderError),
}

macro_rules! create_unreachable {
    () => {
        crate::error::Error::Unreachable {
            line: std::line!(),
            file: std::file!(),
        }
    };
}

pub(crate) use create_unreachable;

/// Alias of result
pub type Result<T> = core::result::Result<T, Error>;

#[cfg(test)]
mod tests {
    /* local use */
    use super::*;

    #[test]
    fn unreachable_macro() {
        assert_matches::assert_matches!(
            create_unreachable!(),
            crate::error::Error::Unreachable {
                line: 88,
                #[cfg(target_family = "windows")]
                file: "src\\error.rs",
                #[cfg(target_family = "unix")]
                file: "src/error.rs",
                #[cfg(target_family = "wasm")]
                file: "src/error.rs",
            }
        );
    }
}