noodles_gff/io/
writer.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
mod line;

use std::io::{self, Write};

use self::line::write_line;
use crate::{DirectiveBuf, LineBuf, RecordBuf};

/// A GFF writer.
pub struct Writer<W> {
    inner: W,
}

impl<W> Writer<W> {
    /// Returns a reference to the underlying writer.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_gff as gff;
    /// let writer = gff::io::Writer::new(io::sink());
    /// let _inner = writer.get_ref();
    /// ```
    pub fn get_ref(&self) -> &W {
        &self.inner
    }

    /// Returns a mutable reference to the underlying writer.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_gff as gff;
    /// let mut writer = gff::io::Writer::new(io::sink());
    /// let _inner = writer.get_mut();
    /// ```
    pub fn get_mut(&mut self) -> &mut W {
        &mut self.inner
    }

    /// Returns the underlying writer.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_gff as gff;
    /// let writer = gff::io::Writer::new(io::sink());
    /// let _inner = writer.into_inner();
    /// ```
    pub fn into_inner(self) -> W {
        self.inner
    }
}

impl<W> Writer<W>
where
    W: Write,
{
    /// Creates a GFF writer.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_gff as gff;
    /// let writer = gff::io::Writer::new(Vec::new());
    /// ```
    pub fn new(inner: W) -> Self {
        Self { inner }
    }

    /// Writes a [`LineBuf`].
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_gff::{self as gff, directive_buf::{key, Value}, LineBuf};
    ///
    /// let mut writer = gff::io::Writer::new(Vec::new());
    ///
    /// let version = LineBuf::Directive(gff::DirectiveBuf::new(
    ///     key::GFF_VERSION,
    ///     Some(Value::GffVersion(Default::default())),
    /// ));
    /// writer.write_line(&version)?;
    ///
    /// let comment = LineBuf::Comment(String::from("noodles"));
    /// writer.write_line(&comment)?;
    ///
    /// let record = LineBuf::Record(gff::RecordBuf::default());
    /// writer.write_line(&record)?;
    ///
    /// let expected = b"##gff-version 3
    /// #noodles
    /// .\t.\t.\t1\t1\t.\t.\t.\t.
    /// ";
    ///
    /// assert_eq!(&writer.get_ref()[..], &expected[..]);
    /// # Ok::<(), io::Error>(())
    pub fn write_line(&mut self, line: &LineBuf) -> io::Result<()> {
        write_line(&mut self.inner, line)
    }

    /// Writes a GFF directive.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_gff::{self as gff, directive_buf::{key, Value}};
    ///
    /// let mut writer = gff::io::Writer::new(Vec::new());
    ///
    /// let version = gff::DirectiveBuf::new(
    ///     key::GFF_VERSION,
    ///     Some(Value::GffVersion(Default::default())),
    /// );
    /// writer.write_directive(&version)?;
    ///
    /// assert_eq!(writer.get_ref(), b"##gff-version 3\n");
    /// # Ok::<(), io::Error>(())
    /// ```
    pub fn write_directive(&mut self, directive: &DirectiveBuf) -> io::Result<()> {
        line::write_directive(&mut self.inner, directive)?;
        line::write_newline(&mut self.inner)
    }

    /// Writes a GFF record.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_gff::{self as gff, directive_buf::{key, Value}};
    ///
    /// let mut writer = gff::io::Writer::new(Vec::new());
    ///
    /// let version = gff::DirectiveBuf::new(
    ///     key::GFF_VERSION,
    ///     Some(Value::GffVersion(Default::default())),
    /// );
    /// writer.write_directive(&version)?;
    ///
    /// let record = gff::RecordBuf::default();
    /// writer.write_record(&record)?;
    ///
    /// let expected = b"##gff-version 3
    /// .\t.\t.\t1\t1\t.\t.\t.\t.
    /// ";
    ///
    /// assert_eq!(&writer.get_ref()[..], &expected[..]);
    /// # Ok::<(), io::Error>(())
    /// ```
    pub fn write_record(&mut self, record: &RecordBuf) -> io::Result<()> {
        line::write_record(&mut self.inner, record)?;
        line::write_newline(&mut self.inner)
    }
}