noodles_gff/directive/
genome_build.rs

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
//! GFF directive genome build.

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

use super::PREFIX;

/// A GFF directive genome build.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct GenomeBuild {
    source: String,
    name: String,
}

impl GenomeBuild {
    /// Creates a genome build directive.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_gff::directive::GenomeBuild;
    /// let genome_build = GenomeBuild::new(String::from("NDLS"), String::from("r1"));
    /// ```
    pub fn new(source: String, name: String) -> Self {
        Self { source, name }
    }

    /// Returns the genome build source.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_gff::directive::GenomeBuild;
    /// let genome_build = GenomeBuild::new(String::from("NDLS"), String::from("r1"));
    /// assert_eq!(genome_build.source(), "NDLS");
    /// ```
    pub fn source(&self) -> &str {
        &self.source
    }

    /// Returns the genome build name.
    ///
    /// # Examples
    ///
    /// ```
    /// use noodles_gff::directive::GenomeBuild;
    /// let genome_build = GenomeBuild::new(String::from("NDLS"), String::from("r1"));
    /// assert_eq!(genome_build.name(), "r1");
    /// ```
    pub fn name(&self) -> &str {
        &self.name
    }
}

impl fmt::Display for GenomeBuild {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}genome-build {} {}", PREFIX, self.source, self.name,)
    }
}

/// An error returned when a raw GFF genome build directive fails to parse.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// The input is empty.
    Empty,
    /// The genome build source is missing.
    MissingSource,
    /// The genome build name is missing.
    MissingName,
}

impl error::Error for ParseError {}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("invalid genome build directive: ")?;

        match self {
            Self::Empty => f.write_str("empty input"),
            Self::MissingSource => f.write_str("missing source"),
            Self::MissingName => f.write_str("missing name"),
        }
    }
}

impl FromStr for GenomeBuild {
    type Err = ParseError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if s.is_empty() {
            return Err(ParseError::Empty);
        }

        let mut args = s.split_ascii_whitespace();

        let source = args
            .next()
            .map(|s| s.into())
            .ok_or(ParseError::MissingSource)?;

        let name = args
            .next()
            .map(|s| s.into())
            .ok_or(ParseError::MissingName)?;

        Ok(Self::new(source, name))
    }
}

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

    #[test]
    fn test_fmt() {
        let genome_build = GenomeBuild::new(String::from("NDLS"), String::from("r1"));
        assert_eq!(genome_build.to_string(), "##genome-build NDLS r1");
    }

    #[test]
    fn test_from_str() -> Result<(), ParseError> {
        assert_eq!(
            "NDLS r1".parse(),
            Ok(GenomeBuild::new(String::from("NDLS"), String::from("r1")))
        );

        assert_eq!("".parse::<GenomeBuild>(), Err(ParseError::Empty));
        assert_eq!("NDLS".parse::<GenomeBuild>(), Err(ParseError::MissingName));

        Ok(())
    }
}