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
use tokio::io::{self, AsyncWrite, AsyncWriteExt};
use crate::{Header, Record};
const LINE_FEED: u8 = b'\n';
/// An async VCF writer.
///
/// If the inner writer is buffered, a call to [`Self::shutdown`] must be made before the writer is
/// dropped.
pub struct Writer<W>
where
W: AsyncWrite,
{
inner: W,
}
impl<W> Writer<W>
where
W: AsyncWrite + Unpin,
{
/// Creates an async VCF writer.
///
/// # Examples
///
/// ```
/// use noodles_vcf as vcf;
/// let writer = vcf::AsyncWriter::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::AsyncWriter::new(Vec::new());
/// assert!(writer.get_ref().is_empty());
/// ```
pub fn get_ref(&self) -> &W {
&self.inner
}
/// Returns a mutable reference to the underlying writer.
///
/// # Examples
///
/// ```
/// use noodles_vcf as vcf;
/// let mut writer = vcf::AsyncWriter::new(Vec::new());
/// assert!(writer.get_mut().is_empty());
/// ```
pub fn get_mut(&mut self) -> &mut W {
&mut self.inner
}
/// Returns the underlying writer.
///
/// # Examples
///
/// ```
/// use noodles_vcf as vcf;
/// let writer = vcf::AsyncWriter::new(Vec::new());
/// assert!(writer.into_inner().is_empty());
/// ```
pub fn into_inner(self) -> W {
self.inner
}
/// Shuts down the output stream.
///
/// # Examples
///
/// ```
/// # use std::io;
/// #
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// use noodles_vcf as vcf;
/// let mut writer = vcf::AsyncWriter::new(Vec::new());
/// writer.shutdown().await?;
/// # Ok(())
/// # }
/// ```
pub async fn shutdown(&mut self) -> io::Result<()> {
self.inner.shutdown().await
}
/// Writes a VCF header.
///
/// # Examples
///
/// ```
/// # use std::io;
/// #
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// use noodles_vcf as vcf;
///
/// let mut writer = vcf::AsyncWriter::new(Vec::new());
///
/// let header = vcf::Header::default();
/// writer.write_header(&header).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write_header(&mut self, header: &Header) -> io::Result<()> {
let raw_header = header.to_string();
self.inner.write_all(raw_header.as_bytes()).await
}
/// Writes a VCF record.
///
/// # Examples
///
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use noodles_vcf::{self as vcf, record::Position};
///
/// let record = vcf::Record::builder()
/// .set_chromosome("sq0".parse()?)
/// .set_position(Position::from(1))
/// .set_reference_bases("A".parse()?)
/// .build()?;
///
/// let mut writer = vcf::AsyncWriter::new(Vec::new());
/// writer.write_record(&record).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write_record(&mut self, record: &Record) -> io::Result<()> {
let raw_record = record.to_string();
self.inner.write_all(raw_record.as_bytes()).await?;
self.inner.write_u8(LINE_FEED).await?;
Ok(())
}
}