noodles_fastq/io/writer/
builder.rs

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
use std::{
    fs::File,
    io::{self, BufWriter, Write},
    path::Path,
};

use super::{Writer, DEFAULT_DEFINITION_SEPARATOR};

/// A FASTQ writer builder.
pub struct Builder {
    definition_separator: u8,
}

impl Builder {
    /// Sets the definition separator.
    ///
    /// By default, this is a space (` `).
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_fastq::io::writer::Builder;
    /// let builder = Builder::default().set_definition_separator(b'\t');
    /// ```
    pub fn set_definition_separator(mut self, definition_separator: u8) -> Self {
        self.definition_separator = definition_separator;
        self
    }

    /// Builds a FASTQ writer from a path.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use noodles_fastq::io::writer::Builder;
    /// let writer = Builder::default().build_from_path("out.fq")?;
    /// # Ok::<_, std::io::Error>(())
    /// ```
    pub fn build_from_path<P>(self, dst: P) -> io::Result<Writer<Box<dyn Write>>>
    where
        P: AsRef<Path>,
    {
        let writer = File::create(dst).map(BufWriter::new)?;
        Ok(self.build_from_writer(writer))
    }

    /// Builds a FASTQ writer from a writer.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use std::io;
    /// use noodles_fastq::io::writer::Builder;
    /// let writer = Builder::default().build_from_writer(io::sink());
    /// # Ok::<_, io::Error>(())
    /// ```
    pub fn build_from_writer<W>(self, writer: W) -> Writer<Box<dyn Write>>
    where
        W: Write + 'static,
    {
        Writer {
            inner: Box::new(writer),
            definition_separator: self.definition_separator,
        }
    }
}

impl Default for Builder {
    fn default() -> Self {
        Self {
            definition_separator: DEFAULT_DEFINITION_SEPARATOR,
        }
    }
}

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

    #[test]
    fn test_default() {
        let builder = Builder::default();
        assert_eq!(builder.definition_separator, b' ');
    }
}