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

//! SAM record data field and components.

pub mod tag;
pub mod value;

pub use self::{tag::Tag, value::Value};

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

pub(crate) const DELIMITER: char = ':';

/// A SAM record data field.
#[derive(Clone, Debug, PartialEq)]
pub struct Field {
    tag: Tag,
    value: Value,
}

impl Field {
    /// Creates a SAM record data field.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_sam::record::data::{field::{Tag, Value}, Field};
    /// let field = Field::new(Tag::AlignmentHitCount, Value::Int(1));
    /// ```
    pub fn new(tag: Tag, value: Value) -> Self {
        Self { tag, value }
    }

    /// Returns the data field tag.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_sam::record::data::{field::{Tag, Value}, Field};
    /// let field = Field::new(Tag::AlignmentHitCount, Value::Int(1));
    /// assert_eq!(field.tag(), &Tag::AlignmentHitCount);
    /// ```
    pub fn tag(&self) -> &Tag {
        &self.tag
    }

    /// Returns the data field value.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_sam::record::data::{field::{Tag, Value}, Field};
    /// let field = Field::new(Tag::AlignmentHitCount, Value::Int(1));
    /// assert!(matches!(field.value(), Value::Int(n) if *n == 1));
    /// ```
    pub fn value(&self) -> &Value {
        &self.value
    }
}

impl fmt::Display for Field {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}{}{}{}{}",
            self.tag,
            DELIMITER,
            self.value.ty(),
            DELIMITER,
            self.value
        )
    }
}

/// An error returned when a raw SAM record data field fails to parse.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// The data field tag is missing.
    MissingTag,
    /// The data field tag is invalid.
    InvalidTag(tag::ParseError),
    /// The data field value is missing.
    MissingValue,
    /// The data field value is invalid.
    InvalidValue(value::ParseError),
}

impl error::Error for ParseError {}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::MissingTag => f.write_str("missing tag"),
            Self::InvalidTag(e) => write!(f, "invalid tag: {}", e),
            Self::MissingValue => f.write_str("missing value"),
            Self::InvalidValue(e) => write!(f, "invalid value: {}", e),
        }
    }
}

impl FromStr for Field {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut components = s.splitn(2, DELIMITER);

        let tag = components
            .next()
            .ok_or(ParseError::MissingTag)
            .and_then(|t| t.parse().map_err(ParseError::InvalidTag))?;

        let value = components
            .next()
            .ok_or(ParseError::MissingValue)
            .and_then(|t| t.parse().map_err(ParseError::InvalidValue))?;

        Ok(Self::new(tag, value))
    }
}

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

    #[test]
    fn test_fmt() {
        let field = Field::new(Tag::ReadGroup, Value::String(String::from("rg0")));
        assert_eq!(field.to_string(), "RG:Z:rg0");
    }
}