eml-nl 0.5.0

Parse, manipulate and emit EML_NL documents
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
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

use std::sync::LazyLock;

use regex::Regex;
use thiserror::Error;

use crate::{EMLError, EMLValueResultExt as _, utils::StringValueData};

/// Regular expression for validating NameShortCode values.
static NAME_SHORT_CODE_RE: LazyLock<Regex> = LazyLock::new(|| {
    Regex::new(r"^(\p{L}*\d{0,7})$").expect("Failed to compile Name Short Code regex")
});

/// A string of type NameShortCode as defined in the EML_NL specification
///
/// Called NameShortCodeType in the schema.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[repr(transparent)]
pub struct NameShortCode(String);

impl NameShortCode {
    /// Create a new NameShortCode from a string, validating its format
    pub fn new(s: impl AsRef<str>) -> Result<Self, EMLError> {
        StringValueData::parse_from_str(s.as_ref()).wrap_value_error()
    }

    /// Get the raw string value of the NameShortCode.
    pub fn value(&self) -> &str {
        &self.0
    }
}

/// Error returned when a string could not be parsed as a NameShortCode
#[derive(Debug, Clone, Error)]
#[error("Invalid name short code: {0}")]
pub struct InvalidNameShortCodeError(String);

impl StringValueData for NameShortCode {
    type Error = InvalidNameShortCodeError;
    fn parse_from_str(s: &str) -> Result<Self, Self::Error>
    where
        Self: Sized,
    {
        // suggested alternative by clippy is not more clear in this case
        #[expect(clippy::len_zero)]
        if s.len() >= 1 && s.len() <= 15 && NAME_SHORT_CODE_RE.is_match(s) {
            Ok(NameShortCode(s.to_string()))
        } else {
            Err(InvalidNameShortCodeError(s.to_string()))
        }
    }

    fn to_raw_value(&self) -> String {
        self.0.clone()
    }
}

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

    #[test]
    fn test_name_short_code_regex_compiles() {
        LazyLock::force(&NAME_SHORT_CODE_RE);
    }

    #[test]
    fn test_valid_name_short_codes() {
        let valid_codes = ["1", "12345", "ABC1234567"];
        for code in valid_codes {
            assert!(
                NameShortCode::new(code).is_ok(),
                "NameShortCode should accept valid code: {}",
                code
            );
        }
    }

    #[test]
    fn test_invalid_name_short_codes() {
        let invalid_codes = ["", "verylongstringthatistoolong", "012345678", "123abc"];
        for code in invalid_codes {
            assert!(
                NameShortCode::new(code).is_err(),
                "NameShortCode should reject invalid code: {}",
                code
            );
        }
    }
}