use indexmap::IndexMap;
use noodles_bgzf as bgzf;
use noodles_csi::{
binning_index::{
index::{
header::ReferenceSequenceNames,
reference_sequence::{bin::Chunk, index::LinearIndex, Bin, Metadata},
Header, ReferenceSequence,
},
ReferenceSequence as _,
},
BinningIndex,
};
use tokio::io::{self, AsyncWrite, AsyncWriteExt};
use crate::Index;
const NUL: u8 = b'\x00';
pub struct Writer<W> {
inner: bgzf::AsyncWriter<W>,
}
impl<W> Writer<W>
where
W: AsyncWrite + Unpin,
{
pub fn new(inner: W) -> Self {
Self {
inner: bgzf::AsyncWriter::new(inner),
}
}
pub fn into_inner(self) -> W {
self.inner.into_inner()
}
pub async fn shutdown(&mut self) -> io::Result<()> {
self.inner.shutdown().await
}
pub async fn write_index(&mut self, index: &Index) -> io::Result<()> {
write_index(&mut self.inner, index).await
}
}
async fn write_index<W>(writer: &mut W, index: &Index) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
write_magic(writer).await?;
let n_ref = i32::try_from(index.reference_sequences().len())
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_i32_le(n_ref).await?;
let header = index
.header()
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "missing tabix header"))?;
write_header(writer, header).await?;
write_reference_sequences(writer, index.reference_sequences()).await?;
if let Some(n_no_coor) = index.unplaced_unmapped_record_count() {
writer.write_u64_le(n_no_coor).await?;
}
Ok(())
}
async fn write_magic<W>(writer: &mut W) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
writer.write_all(crate::MAGIC_NUMBER).await
}
async fn write_header<W>(writer: &mut W, header: &Header) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
let format = i32::from(header.format());
writer.write_i32_le(format).await?;
let reference_sequence_name_index = header
.reference_sequence_name_index()
.checked_add(1)
.expect("attempt to add with overflow");
let col_seq = i32::try_from(reference_sequence_name_index)
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_i32_le(col_seq).await?;
let start_position_index = header
.start_position_index()
.checked_add(1)
.expect("attempt to add with overflow");
let col_beg = i32::try_from(start_position_index)
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_i32_le(col_beg).await?;
let col_end = header.end_position_index().map_or(Ok(0), |mut i| {
i = i.checked_add(1).expect("attempt to add with overflow");
i32::try_from(i).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))
})?;
writer.write_i32_le(col_end).await?;
let meta = i32::from(header.line_comment_prefix());
writer.write_i32_le(meta).await?;
let skip = i32::try_from(header.line_skip_count())
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_i32_le(skip).await?;
write_reference_sequence_names(writer, header.reference_sequence_names()).await?;
Ok(())
}
async fn write_reference_sequence_names<W>(
writer: &mut W,
reference_sequence_names: &ReferenceSequenceNames,
) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
let len: usize = reference_sequence_names.iter().map(|n| n.len() + 1).sum();
let l_nm = i32::try_from(len).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_i32_le(l_nm).await?;
for reference_sequence_name in reference_sequence_names {
writer.write_all(reference_sequence_name.as_bytes()).await?;
writer.write_u8(NUL).await?;
}
Ok(())
}
async fn write_reference_sequences<W>(
writer: &mut W,
reference_sequences: &[ReferenceSequence<LinearIndex>],
) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
for reference_sequence in reference_sequences {
write_reference_sequence(writer, reference_sequence).await?;
}
Ok(())
}
async fn write_reference_sequence<W>(
writer: &mut W,
reference_sequence: &ReferenceSequence<LinearIndex>,
) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
write_bins(
writer,
reference_sequence.bins(),
reference_sequence.metadata(),
)
.await?;
write_intervals(writer, reference_sequence.index()).await?;
Ok(())
}
async fn write_bins<W>(
writer: &mut W,
bins: &IndexMap<usize, Bin>,
metadata: Option<&Metadata>,
) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
let n_bin = i32::try_from(bins.len())
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))
.and_then(|n| {
if metadata.is_some() {
n.checked_add(1)
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "n_bin overflow"))
} else {
Ok(n)
}
})?;
writer.write_i32_le(n_bin).await?;
for (&id, bin) in bins {
write_bin(writer, id, bin).await?;
}
if let Some(m) = metadata {
write_metadata(writer, m).await?;
}
Ok(())
}
async fn write_bin<W>(writer: &mut W, id: usize, bin: &Bin) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
let id = u32::try_from(id).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_u32_le(id).await?;
write_chunks(writer, bin.chunks()).await?;
Ok(())
}
async fn write_chunks<W>(writer: &mut W, chunks: &[Chunk]) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
let n_chunk =
i32::try_from(chunks.len()).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_i32_le(n_chunk).await?;
for chunk in chunks {
write_chunk(writer, chunk).await?;
}
Ok(())
}
async fn write_chunk<W>(writer: &mut W, chunk: &Chunk) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
let cnk_beg = u64::from(chunk.start());
writer.write_u64_le(cnk_beg).await?;
let cnk_end = u64::from(chunk.end());
writer.write_u64_le(cnk_end).await?;
Ok(())
}
async fn write_intervals<W>(writer: &mut W, intervals: &[bgzf::VirtualPosition]) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
let n_intv = i32::try_from(intervals.len())
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_i32_le(n_intv).await?;
for &interval in intervals {
let ioff = u64::from(interval);
writer.write_u64_le(ioff).await?;
}
Ok(())
}
async fn write_metadata<W>(writer: &mut W, metadata: &Metadata) -> io::Result<()>
where
W: AsyncWrite + Unpin,
{
use crate::index::DEPTH;
const METADATA_ID: usize = Bin::metadata_id(DEPTH);
const METADATA_CHUNK_COUNT: usize = 2;
let id =
u32::try_from(METADATA_ID).map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_u32_le(id).await?;
let n_chunk = u32::try_from(METADATA_CHUNK_COUNT)
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
writer.write_u32_le(n_chunk).await?;
let ref_beg = u64::from(metadata.start_position());
writer.write_u64_le(ref_beg).await?;
let ref_end = u64::from(metadata.end_position());
writer.write_u64_le(ref_end).await?;
let n_mapped = metadata.mapped_record_count();
writer.write_u64_le(n_mapped).await?;
let n_unmapped = metadata.unmapped_record_count();
writer.write_u64_le(n_unmapped).await?;
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[tokio::test]
async fn test_write_magic() -> io::Result<()> {
let mut buf = Vec::new();
write_magic(&mut buf).await?;
assert_eq!(buf, b"TBI\x01");
Ok(())
}
#[tokio::test]
async fn test_write_header() -> io::Result<()> {
use noodles_csi::binning_index::index::header;
let header = header::Builder::gff().build();
let mut buf = Vec::new();
write_header(&mut buf, &header).await?;
let expected = [
0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x05, 0x00, 0x00, 0x00, 0x23, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, ];
assert_eq!(buf, expected);
Ok(())
}
#[tokio::test]
async fn test_write_reference_sequence_names() -> io::Result<()> {
let reference_sequence_names = [String::from("sq0"), String::from("sq1")]
.into_iter()
.collect();
let mut buf = Vec::new();
write_reference_sequence_names(&mut buf, &reference_sequence_names).await?;
let expected = [
0x08, 0x00, 0x00, 0x00, 0x73, 0x71, 0x30, 0x00, 0x73, 0x71, 0x31, 0x00, ];
assert_eq!(buf, expected);
Ok(())
}
#[tokio::test]
async fn test_write_metadata() -> io::Result<()> {
let metadata = Metadata::new(
bgzf::VirtualPosition::from(610),
bgzf::VirtualPosition::from(1597),
55,
0,
);
let mut buf = Vec::new();
write_metadata(&mut buf, &metadata).await?;
let expected = [
0x4a, 0x92, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x62, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3d, 0x06, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x37, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, ];
assert_eq!(buf, expected);
Ok(())
}
}