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

//! Indexed alignment reader.

mod builder;

pub use self::builder::Builder;

use std::io::{self, Read, Seek};

use noodles_bam as bam;
use noodles_bgzf as bgzf;
use noodles_core::Region;
use noodles_cram as cram;
use noodles_sam::{self as sam, alignment::Record};

/// An indexed alignment reader.
pub enum IndexedReader<R> {
    /// SAM.
    Sam(sam::IndexedReader<R>),
    /// BAM.
    Bam(bam::IndexedReader<bgzf::Reader<R>>),
    /// CRAM.
    Cram(cram::IndexedReader<R>),
}

impl<R> IndexedReader<R>
where
    R: Read,
{
    /// Reads the SAM header.
    pub fn read_header(&mut self) -> io::Result<sam::Header> {
        match self {
            Self::Sam(reader) => reader.read_header(),
            Self::Bam(reader) => reader.read_header(),
            Self::Cram(reader) => reader.read_header(),
        }
    }

    /// Returns an iterator over records starting from the current stream position.
    pub fn records<'r, 'h: 'r>(
        &'r mut self,
        header: &'h sam::Header,
    ) -> impl Iterator<Item = io::Result<Record>> + 'r {
        let records: Box<dyn Iterator<Item = io::Result<Record>>> =
            match self {
                Self::Sam(reader) => Box::new(reader.records(header)),
                Self::Bam(reader) => Box::new(reader.records(header)),
                Self::Cram(reader) => Box::new(reader.records(header).map(|result| {
                    result.and_then(|record| record.try_into_alignment_record(header))
                })),
            };

        records
    }
}

impl<R> IndexedReader<R>
where
    R: Read + Seek,
{
    /// Returns an iterator over records that intersects the given region.
    pub fn query<'r, 'h: 'r>(
        &'r mut self,
        header: &'h sam::Header,
        region: &Region,
    ) -> io::Result<impl Iterator<Item = io::Result<Record>> + 'r> {
        let records: Box<dyn Iterator<Item = io::Result<Record>>> =
            match self {
                Self::Sam(reader) => reader.query(header, region).map(Box::new)?,
                Self::Bam(reader) => reader.query(header, region).map(Box::new)?,
                Self::Cram(reader) => Box::new(reader.query(header, region)?.map(|result| {
                    result.and_then(|record| record.try_into_alignment_record(header))
                })),
            };

        Ok(records)
    }
}