noodles-util 0.71.0

noodles support utilities
Documentation 
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

//! Async alignment writer.

mod builder;
mod inner;

use noodles_sam as sam;
use tokio::io::{self, AsyncWrite};

pub use self::builder::Builder;
use self::inner::Inner;

/// An async alignment writer.
pub struct Writer<W>(Inner<W>)
where
    W: AsyncWrite;

impl<W> Writer<W>
where
    W: AsyncWrite + Unpin,
{
    /// Writes a SAM header.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[tokio::main]
    /// # async fn main() -> tokio::io::Result<()> {
    /// use noodles_sam as sam;
    /// use noodles_util::alignment::r#async::io::writer::Builder;
    /// use tokio::io::{self, AsyncWriteExt};
    ///
    /// let mut writer = Builder::default().build_from_writer(io::sink()).await?;
    ///
    /// let header = sam::Header::default();
    /// writer.write_header(&header).await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn write_header(&mut self, header: &sam::Header) -> io::Result<()> {
        self.0.write_header(header).await
    }

    /// Writes an alignment record.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[tokio::main]
    /// # async fn main() -> tokio::io::Result<()> {
    /// use noodles_sam as sam;
    /// use noodles_util::alignment::r#async::io::writer::Builder;
    /// use tokio::io::{self, AsyncWriteExt};
    ///
    /// let mut writer = Builder::default().build_from_writer(io::sink()).await?;
    ///
    /// let header = sam::Header::default();
    /// let record = sam::Record::default();
    /// writer.write_record(&header, &record).await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn write_record(
        &mut self,
        header: &sam::Header,
        record: &dyn sam::alignment::Record,
    ) -> io::Result<()> {
        self.0.write_record(header, record).await
    }

    /// Shuts down the alignment format writer.
    ///
    /// # Examples
    ///
    /// ```
    /// # #[tokio::main]
    /// # async fn main() -> tokio::io::Result<()> {
    /// use noodles_sam as sam;
    /// use noodles_util::alignment::{self, io::Format};
    /// use tokio::io;
    ///
    /// let mut writer = alignment::r#async::io::writer::Builder::default()
    ///     .set_format(Format::Sam)
    ///     .build_from_writer(io::sink()).await?;
    ///
    /// let header = sam::Header::default();
    /// writer.shutdown(&header).await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn shutdown(&mut self, header: &sam::Header) -> io::Result<()> {
        self.0.shutdown(header).await
    }
}