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
use tokio::io::{self, AsyncWrite, AsyncWriteExt};
use crate::{Header, Record};
/// An async SAM writer.
pub struct Writer<W>
where
W: AsyncWrite,
{
inner: W,
}
impl<W> Writer<W>
where
W: AsyncWrite + Unpin,
{
/// Creates an async SAM writer.
///
/// # Examples
///
/// ```
/// use noodles_sam as sam;
/// let writer = sam::AsyncWriter::new(Vec::new());
/// ```
pub fn new(inner: W) -> Self {
Self { inner }
}
/// Returns a reference to the underlying writer.
///
/// # Examples
///
/// ```
/// use noodles_sam as sam;
/// let writer = sam::AsyncWriter::new(Vec::new());
/// assert!(writer.get_ref().is_empty());
/// ```
pub fn get_ref(&self) -> &W {
&self.inner
}
/// Returns the underlying writer.
///
/// # Examples
///
/// ```
/// use noodles_sam as sam;
/// let writer = sam::AsyncWriter::new(Vec::new());
/// assert!(writer.into_inner().is_empty());
/// ```
pub fn into_inner(self) -> W {
self.inner
}
/// Writes a SAM header.
///
/// # Examples
///
/// ```
/// # use std::io;
/// #
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// use noodles_sam as sam;
///
/// let mut writer = sam::AsyncWriter::new(Vec::new());
///
/// let header = sam::Header::builder().add_comment("noodles-sam").build();
/// writer.write_header(&header).await?;
///
/// assert_eq!(writer.get_ref(), b"@CO\tnoodles-sam\n");
/// # 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 SAM record.
///
/// # Examples
///
/// ```
/// # use std::io;
/// #
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// use noodles_sam as sam;
///
/// let mut writer = sam::AsyncWriter::new(Vec::new());
///
/// let record = sam::Record::default();
/// writer.write_record(&record).await?;
///
/// assert_eq!(writer.get_ref(), b"*\t4\t*\t0\t255\t*\t*\t0\t0\t*\t*\n");
/// # Ok(())
/// # }
/// ```
pub async fn write_record(&mut self, record: &Record) -> io::Result<()> {
const LINE_FEED: u8 = b'\n';
let raw_record = record.to_string();
self.inner.write_all(raw_record.as_bytes()).await?;
self.inner.write_all(&[LINE_FEED]).await?;
Ok(())
}
}