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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
mod header;
use noodles_bgzf as bgzf;
use noodles_sam as sam;
use tokio::io::{self, AsyncWrite, AsyncWriteExt};
use self::header::write_header;
use crate::Record;
/// An async BAM writer.
pub struct Writer<W> {
inner: W,
buf: Vec<u8>,
}
impl<W> Writer<W>
where
W: AsyncWrite + Unpin,
{
/// Returns a reference to the underlying writer.
///
/// # Examples
///
/// ```
/// use noodles_bam as bam;
/// let writer = bam::r#async::io::Writer::from(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_bam as bam;
/// let mut writer = bam::r#async::io::Writer::from(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_bam as bam;
/// let writer = bam::r#async::io::Writer::from(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_bam as bam;
/// let mut writer = bam::r#async::io::Writer::new(Vec::new());
/// writer.shutdown().await?;
/// # Ok(())
/// # }
/// ```
pub async fn shutdown(&mut self) -> io::Result<()> {
self.inner.shutdown().await
}
/// Writes a SAM header.
///
/// This writes the BAM magic number, the raw SAM header, and a copy of the reference sequence
/// dictionary as binary reference sequences.
///
/// # Examples
///
/// ```
/// # use std::io;
/// #
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// use noodles_bam as bam;
/// use noodles_sam as sam;
///
/// let mut writer = bam::r#async::io::Writer::new(Vec::new());
///
/// let header = sam::Header::default();
/// writer.write_header(&header).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write_header(&mut self, header: &sam::Header) -> io::Result<()> {
write_header(&mut self.inner, header).await
}
/// Writes a BAM record.
///
/// # Examples
///
/// ```
/// # use std::io;
/// #
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// use noodles_bam as bam;
/// use noodles_sam as sam;
///
/// let mut writer = bam::r#async::io::Writer::new(Vec::new());
///
/// let header = sam::Header::default();
/// let record = bam::Record::default();
/// writer.write_record(&header, &record).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write_record(&mut self, header: &sam::Header, record: &Record) -> io::Result<()> {
self.write_alignment_record(header, record).await
}
/// Writes an alignment record.
///
/// # Examples
///
/// ```
/// # use std::io;
/// #
/// # #[tokio::main]
/// # async fn main() -> io::Result<()> {
/// use noodles_bam as bam;
/// use noodles_sam::{self as sam, alignment::RecordBuf};
///
/// let mut writer = bam::r#async::io::Writer::new(Vec::new());
///
/// let header = sam::Header::default();
/// let record = RecordBuf::default();
/// writer.write_alignment_record(&header, &record).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write_alignment_record(
&mut self,
header: &sam::Header,
record: &dyn sam::alignment::Record,
) -> io::Result<()> {
use crate::record::codec::encode;
self.buf.clear();
encode(&mut self.buf, header, record)?;
let block_size = u32::try_from(self.buf.len())
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
self.inner.write_u32_le(block_size).await?;
self.inner.write_all(&self.buf).await?;
Ok(())
}
}
impl<W> Writer<bgzf::AsyncWriter<W>>
where
W: AsyncWrite + Unpin,
{
/// Creates an async BAM writer with a default compression level.
///
/// The given stream is wrapped in a BGZF encoder.
///
/// # Examples
///
/// ```
/// use noodles_bam as bam;
/// let writer = bam::r#async::io::Writer::new(Vec::new());
/// ```
pub fn new(inner: W) -> Self {
Self::from(bgzf::AsyncWriter::new(inner))
}
}
impl<W> From<W> for Writer<W> {
fn from(inner: W) -> Self {
Self {
inner,
buf: Vec::new(),
}
}
}