noodles-util 0.72.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

//! Alignment writer.

pub mod builder;
mod inner;

use std::io::{self, Write};

use noodles_sam::{self as sam, alignment::Record};

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

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

impl<W> Writer<W>
where
    W: Write,
{
    /// Writes a SAM header.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_sam as sam;
    /// use noodles_util::alignment::{self, io::Format};
    ///
    /// let mut writer = alignment::io::writer::Builder::default()
    ///     .set_format(Format::Bam)
    ///     .build_from_writer(io::sink())?;
    ///
    /// let header = sam::Header::default();
    /// writer.write_header(&header)?;
    /// # Ok::<_, io::Error>(())
    /// ```
    pub fn write_header(&mut self, header: &sam::Header) -> io::Result<()> {
        self.0.write_header(header)
    }

    /// Writes an alignment record.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_sam::{self as sam, alignment::RecordBuf};
    /// use noodles_util::alignment::{self, io::Format};
    ///
    /// let mut writer = alignment::io::writer::Builder::default()
    ///     .set_format(Format::Sam)
    ///     .build_from_writer(io::sink())?;
    ///
    /// let header = sam::Header::default();
    /// writer.write_header(&header)?;
    ///
    /// let record = RecordBuf::default();
    /// writer.write_record(&header, &record)?;
    /// # Ok::<_, io::Error>(())
    /// ```
    pub fn write_record<R>(&mut self, header: &sam::Header, record: &R) -> io::Result<()>
    where
        R: Record,
    {
        self.0.write_record(header, record)
    }

    /// Shuts down the alignment format writer.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_sam as sam;
    /// use noodles_util::alignment::{self, io::Format};
    ///
    /// let mut writer = alignment::io::writer::Builder::default()
    ///     .set_format(Format::Sam)
    ///     .build_from_writer(io::sink())?;
    ///
    /// let header = sam::Header::default();
    /// writer.finish(&header)?;
    /// # Ok::<_, io::Error>(())
    /// ```
    pub fn finish(&mut self, header: &sam::Header) -> io::Result<()> {
        self.0.finish(header)
    }
}