noodles-sam 0.85.0

Sequence Alignment/Map (SAM) format reader and writer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

use std::io;

use crate::{Header, alignment::Record};

/// An alignment writer.
///
/// A call to [`Self::finish`] must be made before the writer is dropped.
pub trait Write {
    /// Writes a SAM header.
    fn write_alignment_header(&mut self, header: &Header) -> io::Result<()>;

    /// Writes an alignment record.
    fn write_alignment_record(&mut self, header: &Header, record: &dyn Record) -> io::Result<()>;

    /// Shuts down an alignment writer.
    fn finish(&mut self, header: &Header) -> io::Result<()>;
}