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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
use std::io::{self, Write};
use super::{Header, Record};
/// A VCF writer.
///
/// # Examples
///
/// ```
/// # use std::{convert::TryFrom, io};
/// use noodles_vcf::{self as vcf, header::Contig, record::Position};
///
/// let mut writer = vcf::Writer::new(Vec::new());
///
/// let header = vcf::Header::builder()
/// .add_contig(Contig::new("sq0"))
/// .build();
///
/// writer.write_header(&header)?;
///
/// let record = vcf::Record::builder()
/// .set_chromosome("sq0".parse()?)
/// .set_position(Position::try_from(1)?)
/// .set_reference_bases("A".parse()?)
/// .build()?;
///
/// writer.write_record(&record);
///
/// let expected = b"##fileformat=VCFv4.3
/// ###contig=<ID=sq0>
/// #CHROM\tPOS\tID\tREF\tALT\tQUAL\tFILTER\tINFO
/// sq0\t1\t.\tA\t.\t.\t.\t.
/// ";
///
/// assert_eq!(&writer.get_ref()[..], &expected[..]);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[derive(Debug)]
pub struct Writer<W> {
inner: W,
}
impl<W> Writer<W>
where
W: Write,
{
/// Creates a VCF writer.
///
/// # Examples
///
/// ```
/// use noodles_vcf as vcf;
/// let writer = vcf::Writer::new(Vec::new());
/// ```
pub fn new(inner: W) -> Self {
Self { inner }
}
/// Returns a reference to the underlying writer.
///
/// # Examples
///
/// ```
/// use noodles_vcf as vcf;
/// let writer = vcf::Writer::new(Vec::new());
/// assert!(writer.get_ref().is_empty());
/// ```
pub fn get_ref(&self) -> &W {
&self.inner
}
/// Writes a VCF header.
///
/// # Examples
///
/// ```
/// # use std::io;
/// use noodles_vcf as vcf;
///
/// let mut writer = vcf::Writer::new(Vec::new());
///
/// let header = vcf::Header::default();
/// writer.write_header(&header)?;
/// # Ok::<(), io::Error>(())
/// ```
pub fn write_header(&mut self, header: &Header) -> io::Result<()> {
write!(self.inner, "{}", header)
}
/// Writes a VCF record.
///
/// # Examples
///
/// ```
/// # use std::convert::TryFrom;
/// use noodles_vcf::{self as vcf, record::Position};
///
/// let record = vcf::Record::builder()
/// .set_chromosome("sq0".parse()?)
/// .set_position(Position::try_from(1)?)
/// .set_reference_bases("A".parse()?)
/// .build()?;
///
/// let mut writer = vcf::Writer::new(Vec::new());
/// writer.write_record(&record)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn write_record(&mut self, record: &Record) -> io::Result<()> {
writeln!(self.inner, "{}", record)
}
}
#[cfg(test)]
mod tests {
use std::convert::TryFrom;
use crate::record::{genotypes::Genotype, Format, Position};
use super::*;
#[test]
fn test_write_header() -> io::Result<()> {
let mut writer = Writer::new(Vec::new());
let header = Header::default();
writer.write_header(&header)?;
let expected = b"##fileformat=VCFv4.3
#CHROM\tPOS\tID\tREF\tALT\tQUAL\tFILTER\tINFO
";
assert_eq!(writer.get_ref().as_slice(), &expected[..]);
Ok(())
}
#[test]
fn test_write_record() -> Result<(), Box<dyn std::error::Error>> {
let mut writer = Writer::new(Vec::new());
let record = Record::builder()
.set_chromosome("sq0".parse()?)
.set_position(Position::try_from(1)?)
.set_reference_bases("A".parse()?)
.build()?;
writer.write_record(&record)?;
let expected = b"sq0\t1\t.\tA\t.\t.\t.\t.\n";
assert_eq!(writer.get_ref(), expected);
Ok(())
}
#[test]
fn test_write_record_with_format() -> Result<(), Box<dyn std::error::Error>> {
let mut writer = Writer::new(Vec::new());
let format: Format = "GT:GQ".parse()?;
let record = Record::builder()
.set_chromosome("sq0".parse()?)
.set_position(Position::try_from(1)?)
.set_reference_bases("A".parse()?)
.set_format(format.clone())
.add_genotype(Genotype::from_str_format("0|0:13", &format)?)
.build()?;
writer.write_record(&record)?;
let expected = b"sq0\t1\t.\tA\t.\t.\t.\t.\tGT:GQ\t0|0:13\n";
assert_eq!(writer.get_ref(), expected);
Ok(())
}
}