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

//! Format data generation

/* std use */

/* crates use */

/* module declaration */
#[cfg(feature = "fasta")]
pub mod fasta;

#[cfg(feature = "fastq")]
pub mod fastq;

#[cfg(feature = "vcf")]
pub mod vcf;

#[cfg(feature = "sequence")]
pub mod sequence;

#[cfg(feature = "quality")]
pub mod quality;

/* projet use */
use crate::error;

/// Trait of Format
pub trait Format {
    /// Write header of format in output
    fn header(
        &self,
        output: &mut dyn std::io::Write,
        rng: &mut rand::rngs::StdRng,
    ) -> error::Result<()>;

    /// Write a record in output
    fn record(
        &self,
        output: &mut dyn std::io::Write,
        rng: &mut rand::rngs::StdRng,
    ) -> error::Result<()>;

    /// Write multiple record in output
    fn records(
        &self,
        output: &mut dyn std::io::Write,
        rng: &mut rand::rngs::StdRng,
        number: usize,
    ) -> error::Result<()> {
        for _ in 0..number {
            self.record(output, rng)?;
            output.write_all(&[b'\n'])?;
        }
        Ok(())
    }

    /// Create a file at path with header and multiple records
    fn create<P>(&self, path: P, rng: &mut rand::rngs::StdRng, number: usize) -> error::Result<()>
    where
        P: core::convert::AsRef<std::path::Path>,
    {
        let mut output = std::io::BufWriter::new(std::fs::File::create(path)?);

        self.header(&mut output, rng)?;
        self.records(&mut output, rng, number)?;

        Ok(())
    }
}