bam-builder 1.1.0

A library for easily building BAMs for testing.
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

//! Helper wrappers over awkward [`rust_htslib`] types.
#![warn(missing_docs)]
use rust_htslib::bam::record::Aux;
/// Wrapper type for a ReadGroupID.
#[derive(Debug)]
pub struct ReadGroupId(pub String);

impl Default for ReadGroupId {
    /// Default [`ReadGroupId`] is "A".
    fn default() -> Self {
        Self(String::from("A"))
    }
}

/// Wrapper type for a Sample Name
#[derive(Debug)]
pub struct SampleName(pub String);

impl Default for SampleName {
    /// Default [`SampleName`] is "Sample1".
    fn default() -> Self {
        Self(String::from("Sample1"))
    }
}

/// Wrapper for Aux that owns its own data. [`Aux::from`] is implemented in order
/// to facilitate conversion between the wrapper and the underlying [`Aux`] type.
#[derive(Clone, Debug)]
pub enum AuxType {
    /// Corresponds to [Aux::Integer].
    Integer(i32),
    /// Corresponds to [Aux::String], but as an owned String.
    String(String),
    /// Corresponds to [Aux::Float].
    Float(f32),
    /// Corresponds to [Aux::Char].
    Char(u8),
}

impl<'a> From<&'a AuxType> for Aux<'a> {
    /// Convert a ref [`AuxType`] to ref [`Aux`].
    fn from(aux_type: &'a AuxType) -> Self {
        match aux_type {
            AuxType::Integer(x) => Aux::I32(*x),
            AuxType::String(x) => Aux::String(x.as_str()),
            AuxType::Float(x) => Aux::Float(*x),
            AuxType::Char(x) => Aux::Char(*x),
        }
    }
}

/// Wrapper around strandedness of a read.
#[derive(Clone, Debug)]
pub enum Strand {
    /// Forward strand.
    Plus,
    /// Reverse strand.
    Minus,
}