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

//! Variant writer.

pub(crate) mod builder;

pub use self::builder::Builder;

use std::io;

use noodles_vcf as vcf;

/// A variant writer.
pub struct Writer {
    inner: Box<dyn vcf::variant::io::Write>,
}

impl Writer {
    /// Writes a VCF header.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_vcf as vcf;
    /// use noodles_util::variant::{self, io::{CompressionMethod, Format}};
    ///
    /// let mut writer = variant::io::writer::Builder::default()
    ///     .set_format(Format::Bcf)
    ///     .set_compression_method(Some(CompressionMethod::Bgzf))
    ///     .build_from_writer(io::sink());
    ///
    /// let header = vcf::Header::default();
    /// writer.write_header(&header)?;
    /// # Ok::<_, io::Error>(())
    /// ```
    pub fn write_header(&mut self, header: &vcf::Header) -> io::Result<()> {
        self.inner.write_variant_header(header)
    }

    /// Writes a variant record.
    ///
    /// # Examples
    ///
    /// ```
    /// # use std::io;
    /// use noodles_vcf as vcf;
    /// use noodles_util::variant::{self, io::Format};
    ///
    /// let mut writer = variant::io::writer::Builder::default()
    ///     .set_format(Format::Vcf)
    ///     .set_compression_method(None)
    ///     .build_from_writer(io::sink());
    ///
    /// let header = vcf::Header::default();
    /// writer.write_header(&header)?;
    ///
    /// let record = vcf::variant::RecordBuf::default();
    /// writer.write_record(&header, &record)?;
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn write_record(
        &mut self,
        header: &vcf::Header,
        record: &dyn vcf::variant::Record,
    ) -> io::Result<()> {
        self.inner.write_variant_record(header, record)
    }
}