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

//! VCF header record key.

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

/// A VCF header record key.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum Key {
    /// File format (`fileformat`).
    FileFormat,
    /// Information (`INFO`).
    Info,
    /// Filter (`FILTER`)
    Filter,
    /// Genotype format (`FORMAT`).
    Format,
    /// Symbolic alternate allele (`ALT`).
    AlternativeAllele,
    /// Breakpoint assemblies URI (`assembly`).
    Assembly,
    /// Contig (`contig`).
    Contig,
    /// Meta (`META`).
    Meta,
    /// Sample (`SAMPLE`).
    Sample,
    /// Pedigree (`PEDIGREE`).
    Pedigree,
    /// Pedigree database URI (`pedigreeDB`).
    PedigreeDb,
    /// Any other record key.
    Other(String),
}

impl AsRef<str> for Key {
    fn as_ref(&self) -> &str {
        match self {
            Self::FileFormat => "fileformat",
            Self::Info => "INFO",
            Self::Filter => "FILTER",
            Self::Format => "FORMAT",
            Self::AlternativeAllele => "ALT",
            Self::Assembly => "assembly",
            Self::Contig => "contig",
            Self::Meta => "META",
            Self::Sample => "SAMPLE",
            Self::Pedigree => "PEDIGREE",
            Self::PedigreeDb => "pedigreeDB",
            Self::Other(s) => s,
        }
    }
}

impl fmt::Display for Key {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_ref())
    }
}

/// An error returned when a raw VCF header record kind fails to parse.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// The input is empty.
    Empty,
}

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"),
        }
    }
}

impl FromStr for Key {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "" => Err(ParseError::Empty),
            "fileformat" => Ok(Self::FileFormat),
            "INFO" => Ok(Self::Info),
            "FILTER" => Ok(Self::Filter),
            "FORMAT" => Ok(Self::Format),
            "ALT" => Ok(Self::AlternativeAllele),
            "assembly" => Ok(Self::Assembly),
            "contig" => Ok(Self::Contig),
            "META" => Ok(Self::Meta),
            "SAMPLE" => Ok(Self::Sample),
            "PEDIGREE" => Ok(Self::Pedigree),
            "pedigreeDB" => Ok(Self::PedigreeDb),
            _ => Ok(Self::Other(s.into())),
        }
    }
}

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

    #[test]
    fn test_fmt() {
        assert_eq!(Key::FileFormat.to_string(), "fileformat");
        assert_eq!(Key::Info.to_string(), "INFO");
        assert_eq!(Key::Filter.to_string(), "FILTER");
        assert_eq!(Key::Format.to_string(), "FORMAT");
        assert_eq!(Key::AlternativeAllele.to_string(), "ALT");
        assert_eq!(Key::Assembly.to_string(), "assembly");
        assert_eq!(Key::Contig.to_string(), "contig");
        assert_eq!(Key::Meta.to_string(), "META");
        assert_eq!(Key::Sample.to_string(), "SAMPLE");
        assert_eq!(Key::Pedigree.to_string(), "PEDIGREE");
        assert_eq!(Key::PedigreeDb.to_string(), "pedigreeDB");
        assert_eq!(Key::Other(String::from("fileDate")).to_string(), "fileDate");
    }

    #[test]
    fn test_from_str() {
        assert_eq!("fileformat".parse(), Ok(Key::FileFormat));
        assert_eq!("INFO".parse(), Ok(Key::Info));
        assert_eq!("FILTER".parse(), Ok(Key::Filter));
        assert_eq!("FORMAT".parse(), Ok(Key::Format));
        assert_eq!("ALT".parse(), Ok(Key::AlternativeAllele));
        assert_eq!("assembly".parse(), Ok(Key::Assembly));
        assert_eq!("contig".parse(), Ok(Key::Contig));
        assert_eq!("META".parse(), Ok(Key::Meta));
        assert_eq!("SAMPLE".parse(), Ok(Key::Sample));
        assert_eq!("PEDIGREE".parse(), Ok(Key::Pedigree));
        assert_eq!("pedigreeDB".parse(), Ok(Key::PedigreeDb));
        assert_eq!("fileDate".parse(), Ok(Key::Other(String::from("fileDate"))));

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