eml-nl 0.8.1

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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use thiserror::Error;

use crate::{
    EMLError, EMLValueResultExt as _, EMLVersion, EMLVersionRange, NS_KR,
    io::{EMLElement, EMLElementReader, EMLElementWriter, QualifiedName},
    utils::{StringValue, StringValueData},
};

/// The 'phase' of a count. PhaseCodes correspond to the names of the proces-verbaal
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Phase(StringValue<PhaseCode>);

impl Phase {
    /// Creates a new [`Phase`] from the given [`PhaseCode`].
    pub fn new(code: impl Into<PhaseCode>) -> Self {
        Self(StringValue::Parsed(code.into()))
    }

    /// Returns the parsed value of the phase
    pub fn copied_value(&self) -> Result<PhaseCode, EMLError> {
        self.0.copied_value()
    }

    /// Returns a reference to the underlying [`StringValue`] of the phase
    pub fn value(&self) -> &StringValue<PhaseCode> {
        &self.0
    }
}

/// The phase of a count
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum PhaseCode {
    /// First session ("eerste zitting")
    FirstSession,
    /// Corrigendum ("corrigendum")
    Corrigendum,
}

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

    /// Create a PhaseCode from a `&str`, if possible.
    pub fn from_eml_value(s: impl AsRef<str>) -> Result<Self, UnknownPhaseCodeError> {
        let data = s.as_ref();
        match data {
            "eerste zitting" => Ok(PhaseCode::FirstSession),
            "corrigendum" => Ok(PhaseCode::Corrigendum),
            _ => Err(UnknownPhaseCodeError(data.to_string())),
        }
    }

    /// Get the `&str` representation of this PhaseCode.
    pub fn to_eml_value(&self) -> &'static str {
        match self {
            PhaseCode::FirstSession => "eerste zitting",
            PhaseCode::Corrigendum => "corrigendum",
        }
    }
}

impl From<PhaseCode> for Phase {
    fn from(code: PhaseCode) -> Self {
        Self(StringValue::Parsed(code))
    }
}

impl EMLElement for Phase {
    const EML_NAME: QualifiedName<'_, '_> = QualifiedName::from_static("Phase", Some(NS_KR));
    const EML_VERSIONS: EMLVersionRange = EMLVersionRange::since(EMLVersion::V1_3);

    fn read_eml(elem: &mut EMLElementReader<'_, '_>) -> Result<Self, EMLError> {
        let code = elem.string_value_attr("PhaseCode", None)?;
        Ok(Self(code))
    }

    fn write_eml(&self, writer: EMLElementWriter) -> Result<(), EMLError> {
        writer.attr("PhaseCode", self.0.raw().as_ref())?.empty()
    }
}

/// Error returned when an unknown phase string is encountered.
#[derive(Debug, Clone, Error, PartialEq, Eq)]
#[error("Unknown phase: {0}")]
pub struct UnknownPhaseCodeError(String);

impl From<UnknownPhaseCodeError> for EMLError {
    fn from(err: UnknownPhaseCodeError) -> Self {
        EMLError::value_conversion(err)
    }
}

impl StringValueData for PhaseCode {
    type Error = UnknownPhaseCodeError;

    fn parse_from_str(s: &str) -> Result<Self, Self::Error>
    where
        Self: Sized,
    {
        Self::from_eml_value(s)
    }

    fn to_raw_value(&self) -> Box<str> {
        self.to_eml_value().into()
    }
}