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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! SAM header reference sequence alternative locus.

use std::{error, fmt, str::FromStr};

const UNKNOWN: &str = "*";

/// A SAM header reference sequence alternative locus (`AH`).
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum AlternativeLocus {
    /// A region in the primary assembly.
    Region(String, Option<(i32, i32)>),
    /// The region is unknown.
    Unknown,
}

impl fmt::Display for AlternativeLocus {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Region(reference_sequence_name, Some((start, end))) => {
                write!(f, "{}:{}-{}", reference_sequence_name, start, end)
            }
            Self::Region(reference_sequence_name, None) => f.write_str(reference_sequence_name),
            Self::Unknown => f.write_str(UNKNOWN),
        }
    }
}

/// An error returned when raw SAM header reference sequence alternative locus fails to parse.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// The input is empty.
    Empty,
    /// The reference sequence name is missing.
    MissingReferenceSequenceName,
    /// The reference sequence name is invalid.
    InvalidReferenceSequenceName,
    /// The interval is invalid.
    InvalidInterval,
}

impl error::Error for ParseError {}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Empty => f.write_str("empty input"),
            Self::MissingReferenceSequenceName => f.write_str("missing reference sequence name"),
            Self::InvalidReferenceSequenceName => f.write_str("invalid reference sequence name"),
            Self::InvalidInterval => f.write_str("invalid interval"),
        }
    }
}

impl FromStr for AlternativeLocus {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        use crate::record::reference_sequence_name::is_valid_name;

        match s {
            "" => Err(ParseError::Empty),
            UNKNOWN => Ok(Self::Unknown),
            _ => {
                let mut components = s.splitn(2, ':');

                let reference_sequence_name = components
                    .next()
                    .ok_or(ParseError::MissingReferenceSequenceName)?;

                if !is_valid_name(reference_sequence_name) {
                    return Err(ParseError::InvalidReferenceSequenceName);
                }

                let interval = components
                    .next()
                    .map(|t| parse_interval(t).map(Some))
                    .unwrap_or(Ok(None))?;

                Ok(Self::Region(reference_sequence_name.into(), interval))
            }
        }
    }
}

fn parse_interval(s: &str) -> Result<(i32, i32), ParseError> {
    let mut components = s.splitn(2, '-');

    let start = components
        .next()
        .ok_or(ParseError::InvalidInterval)
        .and_then(|t| t.parse().map_err(|_| ParseError::InvalidInterval))?;

    let end = components
        .next()
        .ok_or(ParseError::InvalidInterval)
        .and_then(|t| t.parse().map_err(|_| ParseError::InvalidInterval))?;

    Ok((start, end))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_fmt() {
        assert_eq!(AlternativeLocus::Unknown.to_string(), "*");

        assert_eq!(
            AlternativeLocus::Region(String::from("sq0"), None).to_string(),
            "sq0"
        );

        assert_eq!(
            AlternativeLocus::Region(String::from("sq0"), Some((8, 13))).to_string(),
            "sq0:8-13"
        );
    }

    #[test]
    fn test_from_str() {
        assert_eq!("*".parse(), Ok(AlternativeLocus::Unknown));

        assert_eq!(
            "sq0".parse(),
            Ok(AlternativeLocus::Region(String::from("sq0"), None))
        );

        assert_eq!(
            "sq0:8-13".parse(),
            Ok(AlternativeLocus::Region(String::from("sq0"), Some((8, 13))))
        );

        assert_eq!("".parse::<AlternativeLocus>(), Err(ParseError::Empty));

        assert_eq!(
            "=".parse::<AlternativeLocus>(),
            Err(ParseError::InvalidReferenceSequenceName)
        );
    }
}